Skip to content

Commit 45d3c78

Browse files
authored
Merge pull request #100 from gary-kim/enh/noid/github_changelog_generator
Add configuration for github_changelog_generator
2 parents 87369a6 + 5fef485 commit 45d3c78

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

.github_changelog_generator

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
user=gary-kim
2+
project=saspes
3+
add_sections={"dependencies": {"labels": ["dependencies"], "prefix": "### Dependencies"}, "Added": {"labels": ["feature"], "prefix": "### Added"}}
4+
output=
5+
header_label=# SAS Powerschool Enhancement Suite Changelog
6+
enhancement_prefix=### Changed
7+
deprecated_prefix=### Deprecated
8+
removed_prefix=### Removed
9+
security_prefix=### Security
10+
bug_prefix=### Fixed
11+
add_pr_wo_labels=false
12+
issues=false

CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,13 @@ For a new file, add this license header to the top of the file:
8989

9090
1. Ensure that all CI tests pass on the latest commit.
9191
2. Update the version number with `npm version [major|minor|patch] --no-git` and update the version name manually in [package.json](package.json).
92-
3. Run `npm ci` to install all dependencies for building from [package-lock.json](package-lock.json).
93-
4. Update [CHANGELOG.md](CHANGELOG.md) with the update changelog for the new version.
94-
5. Make a new git commit and tag with `git commit -S`, `git tag VERSION -a`, add the new version name as the annotation, then run `git push origin VERSION`.
95-
6. Run `npm run libraries` to generate third-party library attributions.
96-
7. Run `npm run clean`, `SASPES_OFFICIAL_RELEASE=true npm run webpack:build:firefox`, then `npm run package`. Upload the resulting package to [AMO](https://addons.mozilla.org/en-US/developers/addons) to have the extension signed. Upload the result into GitHub releases then update the update server to point to the new release.
97-
8. Run `npm run clean`, `SASPES_OFFICIAL_RELEASE=true npm run webpack:build:chromium`, then `npm run package`. Upload the resulting package to [CWS](https://chrome.google.com/webstore/developer/dashboard) to have the new version signed and released.
92+
3. Run [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator) with `--since-tag <LAST VERSION> --future-release <NEW VERSION>` and take the resulting generated changelog and adjust it to our changelog style. Add this to the [CHANGELOG.md](CHANGELOG.md) file and make a PR for the new version. Wait until this PR gets merged (unlike other PRs, this PR should be merged with `--ff-only` rather then a merge commit).
93+
4. Run `npm ci` to install all dependencies for building from [package-lock.json](package-lock.json).
94+
5. Update [CHANGELOG.md](CHANGELOG.md) with the update changelog for the new version.
95+
6. Make a new git commit and tag with `git commit -S`, `git tag VERSION -a`, add the new version name as the annotation, then run `git push origin VERSION`.
96+
7. Run `npm run libraries` to generate third-party library attributions.
97+
8. Run `npm run clean`, `SASPES_OFFICIAL_RELEASE=true npm run webpack:build:firefox`, then `npm run package`. Upload the resulting package to [AMO](https://addons.mozilla.org/en-US/developers/addons) to have the extension signed. Upload the result into GitHub releases then update the update server to point to the new release.
98+
9. Run `npm run clean`, `SASPES_OFFICIAL_RELEASE=true npm run webpack:build:chromium`, then `npm run package`. Upload the resulting package to [CWS](https://chrome.google.com/webstore/developer/dashboard) to have the new version signed and released.
9899

99100
### Developer Certificate of Origin
100101
```

0 commit comments

Comments
 (0)