v4.1.1 #372
Merged
v4.1.1 #372
Conversation
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
- **Fix:** Fixed compilation issues for projects using the `Plans.updatePlan` method in `Version3Client`. Thanks to Jakub Gladykowski ([gladykov](https://github.com/gladykov)) for reporting this issue ([#370](#370)). - **Improvement:** Added `string` type support for the `projectId` property in the `Version` model for `Version3Client`. Thanks to Carl Fürstenberg ([azatoth](https://github.com/azatoth)) for suggesting this improvement ([#371](#371)).
This was
linked to
issues
Apr 4, 2025
Closed
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+6
to
+20
| name: Build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Installing dependencies | ||
| run: npm ci | ||
| - name: Building sources | ||
| run: npm run build | ||
|
|
||
| lint: |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Comment on lines
+21
to
+38
| name: Lint Code | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Installing dependencies | ||
| run: npm ci | ||
| - name: Linting | ||
| run: npm run lint | ||
| env: | ||
| CI: true | ||
|
|
||
| test_unit: |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Comment on lines
+39
to
+54
| name: Unit Tests | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Installing dependencies | ||
| run: npm ci | ||
| - name: Running unit tests | ||
| run: npm run test:unit | ||
|
|
||
| test_integration: |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Comment on lines
+55
to
+78
| name: Integration Tests | ||
| needs: | ||
| - lint | ||
| - test_unit | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Installing dependencies | ||
| run: npm ci | ||
| - name: Creating `.env` file | ||
| run: | | ||
| touch .env | ||
| echo HOST=${{ secrets.HOST }} >> .env | ||
| echo EMAIL=${{ secrets.EMAIL }} >> .env | ||
| echo API_TOKEN=${{ secrets.API_TOKEN }} >> .env | ||
| - name: Running integration tests | ||
| run: npm run test:integration | ||
|
|
||
| publish: |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Comment on lines
+79
to
+100
| name: Package publish | ||
| needs: | ||
| - test_integration | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| registry-url: 'https://registry.npmjs.org' | ||
| - name: Installing dependencies | ||
| run: npm ci | ||
| - name: Building sources | ||
| run: npm run build | ||
| - name: Publishing | ||
| run: npm publish | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
|
|
||
| publish-docs: |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Comment on lines
+138
to
+159
| name: Create Git Tag | ||
| needs: | ||
| - publish | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Extract version from package.json | ||
| run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_ENV | ||
| - name: Create and Push Git Tag | ||
| run: | | ||
| git config user.name "GitHub Actions" | ||
| git config user.email "[email protected]" | ||
| TAG="v${{ env.version }}" | ||
| git tag $TAG | ||
| git push origin $TAG | ||
|
|
||
| creating-github-release: |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Comment on lines
+160
to
+189
| name: Create GitHub Release | ||
| needs: | ||
| - creating-git-tag | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Extract version from package.json | ||
| run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_ENV | ||
| - name: Extract Changelog Entry | ||
| id: changelog | ||
| uses: juliangruber/read-file-action@v1 | ||
| with: | ||
| path: ./CHANGELOG.md | ||
| - name: Parse Changelog Entry | ||
| run: | | ||
| CHANGELOG_CONTENT=$(awk '/^### [0-9]+\.[0-9]+\.[0-9]+/ {if (p) exit; p=1} p' CHANGELOG.md) | ||
| # Sanitize changelog content | ||
| CHANGELOG_CONTENT=$(echo "$CHANGELOG_CONTENT" | sed ':a;N;$!ba;s/\r//g; s/\n/\\n/g') | ||
| echo "CHANGELOG=$CHANGELOG_CONTENT" >> $GITHUB_ENV | ||
| - name: Create GitHub Release | ||
| uses: softprops/action-gh-release@v1 | ||
| with: | ||
| tag_name: v${{ env.version }} | ||
| name: Release v${{ env.version }} | ||
| body: ${{ env.CHANGELOG }} |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Comment on lines
+14
to
+48
| name: Build and Test | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Installing dependencies | ||
| run: npm ci | ||
| - name: Building sources | ||
| run: npm run build | ||
| fetch-depth: 0 | ||
|
|
||
| lint: | ||
| name: Lint Code | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| - name: Setup Node.js ${{ env.NODE_VERSION }} | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Installing dependencies | ||
| node-version: ${{ env.NODE_VERSION }} | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci | ||
| - name: Linting | ||
|
|
||
| - name: Run build | ||
| run: npm run build | ||
|
|
||
| - name: Run lint | ||
| run: npm run lint | ||
| env: | ||
| CI: true | ||
|
|
||
| test_unit: | ||
| name: Unit Tests | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Installing dependencies | ||
| run: npm ci | ||
| - name: Running unit tests | ||
| - name: Run unit tests | ||
| run: npm run test:unit | ||
|
|
||
| test_integration: | ||
| name: Integration Tests | ||
| needs: | ||
| - lint | ||
| - test_unit | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Installing dependencies | ||
| run: npm ci | ||
| - name: Creating `.env` file | ||
| run: | | ||
| touch .env | ||
| echo HOST=${{ secrets.HOST }} >> .env | ||
| echo EMAIL=${{ secrets.EMAIL }} >> .env | ||
| echo API_TOKEN=${{ secrets.API_TOKEN }} >> .env | ||
| - name: Running integration tests | ||
| - name: Run integration tests | ||
| run: npm run test:integration | ||
| env: | ||
| HOST: ${{ secrets.HOST }} | ||
| EMAIL: ${{ secrets.EMAIL }} | ||
| API_TOKEN: ${{ secrets.API_TOKEN }} | ||
|
|
||
| publish: | ||
| name: Package publish | ||
| needs: | ||
| - test_integration | ||
| publish-package: |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Comment on lines
+49
to
+105
| name: Publish Package | ||
| needs: build-and-test | ||
| runs-on: ubuntu-latest | ||
| if: github.ref == 'refs/heads/master' | ||
| steps: | ||
| - name: Checkout sources | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Setup Node.js ${{ env.NODE_VERSION }} | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| node-version: ${{ env.NODE_VERSION }} | ||
| registry-url: 'https://registry.npmjs.org' | ||
| - name: Installing dependencies | ||
|
|
||
| - name: Get and validate version | ||
| id: version | ||
| run: | | ||
| # Get version from tag if exists | ||
| if [[ $GITHUB_REF == refs/tags/v* ]]; then | ||
| TAG_VERSION=${GITHUB_REF#refs/tags/v} | ||
| echo "Using version from tag: $TAG_VERSION" | ||
| CURRENT_VERSION=$(node -p "require('./package.json').version") | ||
|
|
||
| if [ "$TAG_VERSION" != "$CURRENT_VERSION" ]; then | ||
| echo "Updating package version to match tag..." | ||
| npm version $TAG_VERSION --no-git-tag-version | ||
| npm install | ||
| git config user.name "GitHub Actions" | ||
| git config user.email "[email protected]" | ||
| git add package.json package-lock.json | ||
| git commit -m "Update version to $TAG_VERSION [skip ci]" | ||
| git push | ||
| fi | ||
| else | ||
| TAG_VERSION=$(node -p "require('./package.json').version") | ||
| echo "Using version from package.json: $TAG_VERSION" | ||
| fi | ||
|
|
||
| echo "version=$TAG_VERSION" >> $GITHUB_OUTPUT | ||
| echo "VERSION=$TAG_VERSION" >> $GITHUB_ENV | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.PAT }} | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci | ||
| - name: Building sources | ||
|
|
||
| - name: Build package | ||
| run: npm run build | ||
| - name: Publishing | ||
|
|
||
| - name: Publish to NPM | ||
| run: npm publish | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
|
|
||
| publish-docs: | ||
| name: Docs publish | ||
| needs: | ||
| - publish | ||
| deploy-documentation: |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Comment on lines
+106
to
+132
| steps: | ||
| - name: Checkout code | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: master | ||
| - name: Use Node.js 18.x.x | ||
|
|
||
| - name: Setup Node.js ${{ env.NODE_VERSION }} | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Installing dependencies | ||
| node-version: ${{ env.NODE_VERSION }} | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci | ||
| - name: Generate docs | ||
|
|
||
| - name: Generate documentation | ||
| run: npm run doc | ||
| - name: Extract version | ||
| id: pkg | ||
| run: echo "VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_ENV | ||
| - name: Checkout docs branch | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: docs | ||
| clean: false | ||
| - name: Copy docs to root | ||
| run: | | ||
| cp -r docs/* . | ||
| - name: Commit and push docs | ||
| run: | | ||
| git config user.name "GitHub Actions" | ||
| git config user.email "[email protected]" | ||
| git add . | ||
| git commit -m "Update documentation for version v${{ env.VERSION }}" | ||
| git push | ||
|
|
||
| creating-git-tag: | ||
| name: Create Git Tag | ||
| needs: | ||
| - publish | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Extract version from package.json | ||
| run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_ENV | ||
| - name: Create and Push Git Tag | ||
| run: | | ||
| git config user.name "GitHub Actions" | ||
| git config user.email "[email protected]" | ||
| TAG="v${{ env.version }}" | ||
| git tag $TAG | ||
| git push origin $TAG | ||
|
|
||
| creating-github-release: | ||
| name: Create GitHub Release | ||
| needs: | ||
| - creating-git-tag | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v4 | ||
| - name: Use Node.js 18.x.x | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| - name: Extract version from package.json | ||
| run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_ENV | ||
| - name: Extract Changelog Entry | ||
| id: changelog | ||
| uses: juliangruber/read-file-action@v1 | ||
| with: | ||
| path: ./CHANGELOG.md | ||
| - name: Parse Changelog Entry | ||
| run: | | ||
| CHANGELOG_CONTENT=$(awk '/^### [0-9]+\.[0-9]+\.[0-9]+/ {if (p) exit; p=1} p' CHANGELOG.md) | ||
| # Sanitize changelog content | ||
| CHANGELOG_CONTENT=$(echo "$CHANGELOG_CONTENT" | sed ':a;N;$!ba;s/\r//g; s/\n/\\n/g') | ||
| echo "CHANGELOG=$CHANGELOG_CONTENT" >> $GITHUB_ENV | ||
| - name: Create GitHub Release | ||
| uses: softprops/action-gh-release@v1 | ||
|
|
||
| - name: Deploy to docs branch | ||
| uses: JamesIves/github-pages-deploy-action@v4 | ||
| with: | ||
| tag_name: v${{ env.version }} | ||
| name: Release v${{ env.version }} | ||
| body: ${{ env.CHANGELOG }} | ||
| branch: docs | ||
| folder: docs | ||
| clean: true | ||
| commit-message: "docs: Update documentation for v${{ needs.publish-package.outputs.version }} [skip ci]" |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Plans.updatePlanmethod inVersion3Client. Thanks to Jakub Gladykowski (gladykov) for reporting this issue (#370).stringtype support for theprojectIdproperty in theVersionmodel forVersion3Client. Thanks to Carl Fürstenberg (azatoth) for suggesting this improvement (#371).