Skip to content

Commit

Permalink
Merge branch 'main' into fix-typo
Browse files Browse the repository at this point in the history
  • Loading branch information
georgedias authored Dec 28, 2024
2 parents 374facd + 04b71e1 commit 72f1d14
Show file tree
Hide file tree
Showing 19 changed files with 1,845 additions and 841 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- name: setup node
uses: actions/setup-node@v4
with:
node-version: "18"
node-version: "22"
check-latest: true
cache: 'npm'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-rpm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
- name: setup node
uses: actions/setup-node@v4
with:
node-version: "18"
node-version: "22"
check-latest: true
cache: 'npm'
cache-dependency-path: ./saf/package-lock.json
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-windows-linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: setup node
uses: actions/setup-node@v4
with:
node-version: "20"
node-version: "22"
check-latest: true
cache: 'npm'
cache-dependency-path: ./saf/package-lock.json
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/e2e-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Setup Node.js on ${{ matrix.platform }}
uses: actions/setup-node@v4
with:
node-version: "18"
node-version: "22"
check-latest: true
cache: 'npm'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "18"
node-version: "22"
check-latest: true
cache: 'npm'

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/push-to-npm-gpr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- name: setup node
uses: actions/setup-node@v4
with:
node-version: "18"
node-version: "22"
check-latest: true
registry-url: "https://registry.npmjs.org"
cache: 'npm'
Expand All @@ -34,7 +34,7 @@ jobs:
# Setup .npmrc file to publish to GitHub Package Registry
- uses: actions/setup-node@v4
with:
node-version: "18"
node-version: "22"
registry-url: 'https://npm.pkg.github.com'
cache: 'npm'

Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v18.18
v22.0.0
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ARG BASE_CONTAINER=node:18-alpine
ARG BASE_CONTAINER=node:22-alpine

FROM $BASE_CONTAINER AS builder

Expand Down
33 changes: 33 additions & 0 deletions docs/contributors-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,39 @@ You can get help on the available commands with:
./bin/run --help # Darwin or Linux
node bin/run --help # Windows
```
## Creating a Release
The process of creating a release is document in the SAF CLI Wiki Page [How-to Create a SAF CLI Release](https://github.com/mitre/saf/wiki/How%E2%80%90to-Create-a-SAF-CLI-Release)

>[!WARNING]
> Before executing the preparatory script ensure that the you're on a directory containing the most recent commit of the SAF CLI. The first step of the scrip will do a `git checkout main` proceeding by a `git pull origin main`
Basically the process of creating a SAF CLI release consists of performing the following steps:

1. Run the appropriate preparatory release script
```bash
./release-pre.sh # Darwin or Linux
.\release-pre.ps1 # Windows
```
The script performs the following:

- Retrieve the latest main content
- Bump the SAF CLI version number in the VERSION file and package.json
- Update MITRE dependencies to latest versions
- Remove the `node_modules` if exists
- Install all supporting modules
- Build and run all tests
- Add unstaged files to the staging area (package.json - version) or any other file with the modified flag (M)
- Commit previously staged files with `signoff` tag with the new version number
- Tag the commit with new release version
- Push and updated all three references to the repository with the version number

2. Add the generated packages to the staged released
3. Associate the tags with the drafted release
4. Set the release to be the latest
5. Publish the release

>[!NOTE]
>Detailed information on steps 2 through 5 are listed in the [How-to Create a SAF CLI Release](https://github.com/mitre/saf/wiki/How%E2%80%90to-Create-a-SAF-CLI-Release) Wiki page

## Contributing

Expand Down
Loading

0 comments on commit 72f1d14

Please sign in to comment.