Discourse/discourse
Discourse/discourse
0
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/discourse/discourse.git synced 2026-05-07 10:56:41 +08:00
Code Packages Activity Actions
discourse/plugins/discourse-github
History
Exact
Jarek Radosz d10c1e57e8
DEV: Overhaul typechecking configuration (#35794) 
- Switches to typescript 'composite project' mode for improved
organization & performance
- Generates declarations from core modules, and outputs to a new
`@discourse/types` package
- Introduces tsconfigs for core plugins, which leans on that new
`@discourse/types` package
- In future, we plan to publish this discourse-types package for other
themes/plugins to use

The motivation at this stage is primarily to improve editor
autocompletion. We provide absolutely no guarantees about the accuracy
or stability of the generated types.

For now, some issues have been resolved by adding manual `@type`
declarations.

In particular, extensionless imports of `.gjs` files are broken when
running in composite-project mode, so in those cases we have to add
manual `@type {import("./the-file.gjs").default}` declarations.
Unfortunately this failure does not show up in IDEs. We hope to get this
resolved soon.

---------

Co-authored-by: David Taylor <david@taylorhq.com>
Co-authored-by: Chris Manson <chris@manson.ie>
2025-11-12 12:54:34 +00:00
..
app DEV: Clean up scope resolution operators in plugins (#34979) 2025-09-30 14:36:34 +02:00
config Update translations (#35316) 2025-10-15 12:05:55 +02:00
db/migrate
spec DEV: Update rubocop-discourse to 3.13 and autofix issues (#35073) 2025-10-06 16:11:01 +02:00
package.json DEV: Overhaul typechecking configuration (#35794) 2025-11-12 12:54:34 +00:00
plugin.rb DEV: Clean up requires (#34946) 2025-09-24 12:00:22 +02:00
README.md
tsconfig.json DEV: Overhaul typechecking configuration (#35794) 2025-11-12 12:54:34 +00:00

README.md

Discourse Github

https://meta.discourse.org/t/discourse-github/99895/

This plugin combines functionality of deprecated github_badges and discourse-github-linkback plugins.

Installation

Follow the plugin installation guide.

Github Badges

Assign badges to your users based on GitHub contributions.

How to use:

  1. Enable github badges enabled in Settings -> Plugins.

  2. Generate an access token on Github. Be sure to give it only the public_repo scope. Paste that token into the github linkback access token setting.

  3. Add URL of the GitHub repo to scan for contributions to the github badges repo site setting.

Github Linkback

Create a link from a Github pull request or commit back to a Discourse post where it is mentioned.

How to use:

  1. Enable github linkback enabled in Settings -> Plugins.

  2. Generate an access token on Github. Be sure to give it only the public_repo scope. Paste that token into the github linkback access token setting.

  3. Finally, add the projects you wish to post to in the github linkback projects site setting in the formats:

    • username/repository for specific repositories
    • username/* for all repositories of a certain user

Github Permalink

Replace Github non-permalinks with permalinks.

How to use:

  1. Enable github permalinks enabled in Settings -> Plugins.
  2. If you want to exclude certain files or directories from permalink overwrites, you can modify that in the github permalinks exclude site setting in the following formats:
    • filename links to all files with matching filename
    • username/* links to all repositories belonging to the user/organization
    • username/repository/* links to any file in the repository
    • username/repository/directory/* links to any file in the directory within repository
    • username/repository/file.rb a specific file