Skip to content

Commit c741d4e

Browse files
authored
feat: GAUD-292 - Use new release token (#79)
* GAUD-292 - Use new release token * Switch to node 20 * Update README * Simplify and fix CI
1 parent 5027f72 commit c741d4e

File tree

4 files changed

+6
-55
lines changed

4 files changed

+6
-55
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,7 @@ jobs:
1515
run: npm ci
1616
- name: Lint (JavaScript)
1717
run: npm run test:lint
18-
unit-fork:
19-
if: ${{ github.event.pull_request.head.repo.full_name != github.repository }}
20-
name: Unit Tests fork
21-
timeout-minutes: 2
22-
runs-on: ubuntu-latest
23-
steps:
24-
- uses: Brightspace/third-party-actions@actions/checkout
25-
- uses: Brightspace/third-party-actions@actions/setup-node
26-
with:
27-
node-version-file: .nvmrc
28-
cache: 'npm'
29-
- name: Install dependencies
30-
run: npm ci
31-
- name: Headless Tests
32-
run: npm run test:headless
3318
unit:
34-
if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
3519
name: Unit Tests
3620
timeout-minutes: 2
3721
runs-on: ubuntu-latest
@@ -45,6 +29,6 @@ jobs:
4529
run: |
4630
npm ci
4731
npm install @web/test-runner-playwright --no-save
48-
npx playwright install-deps
32+
npx playwright install --with-deps
4933
- name: tests
5034
run: npx web-test-runner test/**/*.test.js --node-resolve --group default --playwright --browsers chromium firefox webkit

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ jobs:
2222
- name: Semantic Release
2323
uses: BrightspaceUI/actions/semantic-release@main
2424
with:
25-
GITHUB_TOKEN: ${{ secrets.D2L_GITHUB_TOKEN }}
25+
GITHUB_TOKEN: ${{ secrets.D2L_RELEASE_TOKEN }}
2626
NPM: true
2727
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
18
1+
20

README.md

Lines changed: 3 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -186,41 +186,8 @@ We recommend:
186186
* [fetch](https://github.com/github/fetch)
187187
* [promise-polyfill](https://github.com/PolymerLabs/promise-polyfill/)
188188

189-
## Versioning & Releasing
189+
## Versioning and Releasing
190190

191-
> TL;DR: Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`. Read on for more details...
191+
This repo is configured to use `semantic-release`. Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`.
192192

193-
The [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) is called from the `release.yml` GitHub Action workflow to handle version changes and releasing.
194-
195-
### Version Changes
196-
197-
All version changes should obey [semantic versioning](https://semver.org/) rules:
198-
1. **MAJOR** version when you make incompatible API changes,
199-
2. **MINOR** version when you add functionality in a backwards compatible manner, and
200-
3. **PATCH** version when you make backwards compatible bug fixes.
201-
202-
The next version number will be determined from the commit messages since the previous release. Our semantic-release configuration uses the [Angular convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) when analyzing commits:
203-
* Commits which are prefixed with `fix:` or `perf:` will trigger a `patch` release. Example: `fix: validate input before using`
204-
* Commits which are prefixed with `feat:` will trigger a `minor` release. Example: `feat: add toggle() method`
205-
* To trigger a MAJOR release, include `BREAKING CHANGE:` with a space or two newlines in the footer of the commit message
206-
* Other suggested prefixes which will **NOT** trigger a release: `build:`, `ci:`, `docs:`, `style:`, `refactor:` and `test:`. Example: `docs: adding README for new component`
207-
208-
To revert a change, add the `revert:` prefix to the original commit message. This will cause the reverted change to be omitted from the release notes. Example: `revert: fix: validate input before using`.
209-
210-
### Releases
211-
212-
When a release is triggered, it will:
213-
* Update the version in `package.json`
214-
* Tag the commit
215-
* Create a GitHub release (including release notes)
216-
* Deploy a new package to NPM
217-
218-
### Releasing from Maintenance Branches
219-
220-
Occasionally you'll want to backport a feature or bug fix to an older release. `semantic-release` refers to these as [maintenance branches](https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#maintenance-branches).
221-
222-
Maintenance branch names should be of the form: `+([0-9])?(.{+([0-9]),x}).x`.
223-
224-
Regular expressions are complicated, but this essentially means branch names should look like:
225-
* `1.15.x` for patch releases on top of the `1.15` release (after version `1.16` exists)
226-
* `2.x` for feature releases on top of the `2` release (after version `3` exists)
193+
To learn how to create major releases and release from maintenance branches, refer to the [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) documentation.

0 commit comments

Comments
 (0)