Skip to content

Commit

Permalink
Merge pull request #442 from SuperITMan/feature/update-outdated-deps
Browse files Browse the repository at this point in the history
  • Loading branch information
SuperITMan authored Dec 12, 2023
2 parents e194dbe + 618c01c commit 5f1d356
Show file tree
Hide file tree
Showing 7 changed files with 7,385 additions and 12,081 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ jobs:
env:
LOGS_DIR: /tmp/code-style/logs
LOGS_FILE: /tmp/code-style/logs/build-perf.log
NPM_VERSION: "8.x"
NPM_VERSION: "10.x"
TZ: "Europe/Brussels"
steps:
# See: https://github.com/marketplace/actions/checkout
- uses: actions/checkout@v4

# See: https://github.com/marketplace/actions/setup-node-js-environment
- name: Use Node.js 14
- name: Use Node.js 18
uses: actions/setup-node@v4
with:
node-version: "14"
node-version: "18"

- name: Create file & folder for GitHub Actions logs
run: |
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
8.9.4
18
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ TODO add project structure details

If you want to build code-style from source, you need to...

- install NodeJS (12.0.0+) and npm (7.0.0+)
- install NodeJS (18.0.0+) and npm (10.0.0+)
- clone this git repository: `git clone https://github.com/NationalBankBelgium/code-style.git`
- run `npm run install` from the root directory of code-style

Expand Down
38 changes: 19 additions & 19 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ It will be used by release-it to push to and create the release page on GitHub (

On GitHub Actions, the following should be configured:

- NPM_TOKEN environment variable
- if 2FA is enabled for the account the only auth-only level can be used: https://docs.npmjs.com/getting-started/using-two-factor-authentication#levels-of-authentication
- that variable MUST NEVER be logged/exposed. If exposed then the token MUST be revoked and the account password changed ASAP
- NPM_TOKEN environment variable
- if 2FA is enabled for the account the only auth-only level can be used: https://docs.npmjs.com/getting-started/using-two-factor-authentication#levels-of-authentication
- that variable MUST NEVER be logged/exposed. If exposed then the token MUST be revoked and the account password changed ASAP

## Changelog

Expand All @@ -26,10 +26,10 @@ We use the Angular format for our changelog and for it to work properly, please

Make sure that:

- all changes have merged into master
- everything is up to date locally
- everything is clean locally
- execute `npm run release`
- all changes have merged into master
- everything is up to date locally
- everything is clean locally
- execute `npm run release`

Enjoy the show.

Expand All @@ -44,14 +44,14 @@ Refer to the "Adapting tags of published packages" section below.

### release

- first we make sure that there are no local changes (if there are we stop right there)
- then we execute release-it: https://github.com/webpro/release-it which
- bumps the version in the root package.json automatically (determines the bump type to use depending on the commit message logs)
- that version number will be used as basis in the build to adapt all other package.json files
- generates/updates the CHANGELOG.md file using: conventional-changelog: https://github.com/conventional-changelog
- commits both package.json and CHANGELOG.md
- creates a new git tag and pushes it
- creates a github release page and makes it final
- first we make sure that there are no local changes (if there are we stop right there)
- then we execute release-it: https://github.com/webpro/release-it which
- bumps the version in the root package.json automatically (determines the bump type to use depending on the commit message logs)
- that version number will be used as basis in the build to adapt all other package.json files
- generates/updates the CHANGELOG.md file using: conventional-changelog: https://github.com/conventional-changelog
- commits both package.json and CHANGELOG.md
- creates a new git tag and pushes it
- creates a github release page and makes it final

After this, the release is tagged and visible on github

Expand All @@ -62,10 +62,10 @@ Finally, GitHub Actions executes `npm run release:publish`.
That script makes some checks then, if all succeed it publishes the different packages on npm.
Checks that are performed:

- node version: should be "10"
- NPM_TOKEN environment variable should be defined
- GITHUB_REPOSITORY should be "NationalBankBelgium/code-style"
- GH_ACTIONS_TAG should be defined and not empty (this is the case when GitHub Actions builds for a tag)
- node version: should be "18"
- NPM_TOKEN environment variable should be defined
- GITHUB_REPOSITORY should be "NationalBankBelgium/code-style"
- GH_ACTIONS_TAG should be defined and not empty (this is the case when GitHub Actions builds for a tag)

## Adapting tags of published packages

Expand Down
Loading

0 comments on commit 5f1d356

Please sign in to comment.