-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding CONTRIBUTING.md with 'New Version Release Procedure'.
- Loading branch information
1 parent
6e5251e
commit 771b22f
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contributing | ||
|
||
For general contributions, please open an issue on GitHub using one of the below templates: | ||
- [Bug Report](https://github.com/ChrisCarini/intellij-platform-plugin-verifier-action/issues/new?assignees=&labels=&template=bug_report.md&title=) | ||
- [Feature Request](https://github.com/ChrisCarini/intellij-platform-plugin-verifier-action/issues/new?assignees=&labels=&template=feature_request.md&title=) | ||
|
||
|
||
## New Version Release Procedure | ||
|
||
1. Navigate to | ||
the [GitHub Releases page for ChrisCarini/intellij-platform-plugin-verifier-action](https://github.com/ChrisCarini/intellij-platform-plugin-verifier-action/releases) | ||
2. Click `Draft a new release` | ||
3. Enter the below information | ||
1. Ensure `Publish this Action to the GitHub Marketplace` is selected | ||
2. **version tag:** we follow the format `v<version>` (ie, `v1.0.1`) | ||
3. **target:** Likely targeting the `master` branch, but possible a different commit. | ||
4. **release title:** `Release v<version>` (ie, `Release v1.0.1`) | ||
5. **description:** | ||
```markdown | ||
<SHORT_DESCRIPTION_ONE_OR_TWO_SENTENCES> | ||
|
||
### Added | ||
|
||
1. N/A | ||
|
||
### Upgrade | ||
|
||
1. N/A | ||
|
||
### Fixed | ||
|
||
1. N/A | ||
``` | ||
(**Note:** Update the `Added`, `Upgrade`, and `Fixed` sections as needed, linking to GitHub PRs/Issues when | ||
appropriate.) | ||
4. Click `Publish Release` | ||
5. Update the `latest` tag to the most current release: | ||
```shell | ||
git tag -d latest && git push origin :refs/tags/latest && git tag latest master && git push origin latest | ||
``` |