-
Notifications
You must be signed in to change notification settings - Fork 0
Setup
Alex B edited this page Mar 1, 2024
·
4 revisions
If you want to use this template do the following:
- Clone the addon-template repository locally into a new (temporary) folder
- Create a new (empty - with no content) GitHub repository
- Change the origin of the cloned repo so that points to the newly created empty GitHub repo (this might be helpful)
- The newly created GitHub repo should now contain the contents of this template, you can remove the temporary fodler now
- Replace
intellij-plugin-template
andpluginId
- Check the Readme
Some settings may require a public repository
- Disable wikis (they are not used by us because the lack versioning and accessibility)
- Disable discussions (issues are sufficient)
- Disable projects (we have a "super"-project that already takes care of that - we don't need a separate project per repo)
- Enable "Automatically delete head branches" (so that there are no "dead"-PR branches)
- Enable "Limit how many branches and tags can be updated in a single push" (Up to 5)
- Add the corresponding Team with role
Admin
- Default branch:
develop
- Create and enable branch protection for
-
develop
(Development-Branch) -
master
("Current Release"-Branch)
-
- Enable "Private vulnerability reporting"
- Enable "Dependabot alerts"
- Enable "Dependabot security updates"
- Enable "Secret scanning"
These need to be added by an organization administrator
- Required for releasing to JetBrains marketplace
JETBRAINS_MARKETPLACE_CERTIFICATE_CHAIN
JETBRAINS_MARKETPLACE_PRIVATE_KEY
JETBRAINS_MARKETPLACE_PRIVATE_KEY_PASSWORD
JETBRAINS_MARKETPLACE_PUBLISH_TOKEN
- Required for SonarCloud integration
-
SONAR_TOKEN
- The token belongs to https://github.com/xdev-gh-bot
-
- Required for updates from the template
-
UPDATE_FROM_TEMPLATE_PAT
- The PAT belongs to https://github.com/xdev-gh-bot
-
- Install SonarCloud (required for SonarCloud integration)
- Create a new project in our SonarCloud organisation and name it exactly like the created repo name
- Setup "New code" by using "Number of days"=30
- Disable "Automatic Analysis" in "Administration/Analysis method"
- To check if SonarCloud is working go to the GitHub actions Tab and execute the
Sonar
workflow manually - Check the results and possibly fix them
Change the Repository Details/About
- Add a description
- Add some Topics/Labels, e.g.
intellij-plugin
Once in a week a GitHub action is executed that tries to sync the changes from the template.
If changes are found a PR is created.
Check the PR changes from time to time and merge them into the develop.