Skip to content

Initial release of get-cmake action#1

Merged
amanstep merged 10 commits intomainfrom
release
Apr 24, 2025
Merged

Initial release of get-cmake action#1
amanstep merged 10 commits intomainfrom
release

Conversation

@amanstep
Copy link
Copy Markdown
Contributor

@Raj-StepSecurity @varunsh-coder Please review this PR and suggest if any changes are to be made

commented out the portion in built-test-tmpl.yml trying to create a new PR for new CMAKE version
Fixed .gitignore to start tracking imoportant js files
src/get-cmake.ts Outdated

function forceExit(exitCode: number) {
// work around for:
// - https://github.com/lukka/get-cmake/issues/136
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove mention of author

LICENSE Outdated
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2023 StepSecurity
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add copyright of author
ie Copyright (c) 2020-2021-2022-2023-2024 Luca Cappa

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and keep the stepsecurity copyright as well ?

Copy link
Copy Markdown
Contributor

@Raj-StepSecurity Raj-StepSecurity Apr 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, u can check some other repo for reference

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*Copyright (c) 2025 StepSecurity

.eslintrc.js Outdated
@@ -0,0 +1,23 @@
// Copyright (c) 2020-2023 Luca Cappa
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

around 16 mentions of author is present, please remove

# script:
# description: "Specify the build script to run"
# required: true
# type: string
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove commented

README.md Outdated
- [Generate the catalog of CMake releases](#generate-the-catalog-of-cmake-releases)
- [Packaging](#packaging)
- [Testing](#testing)
- [Contributing](#contributing)
Copy link
Copy Markdown
Contributor

@Raj-StepSecurity Raj-StepSecurity Apr 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove Contributing, Who is using

README.md Outdated
# License
All the content in this repository is licensed under the [MIT License](LICENSE).

Copyright (c) 2020-2021-2022-2023-2024 Step Security No newline at end of file
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copyright (c) 2025 Step Security

removed name of author and other commented code which was not required.
Commented code related to generating catalog and updating new Cmake and ninja version through PR.
Commented out code that required persistent secrets
.gitmodules Outdated
@@ -0,0 +1,3 @@
[submodule "libs"]
path = libs
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this folder does not exist in our code which means its unused, we can safely remove the same. We can just re verify all test cases post that

tag:
description: "Tag for the release"
required: true

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to add npm run pack

workflow_dispatch:
inputs:
force:
description: "Use --force flag for npm audit fix?"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add npm run pack

if: false #Disable buildjet's arm based runners usage.
uses: ./.github/workflows/build-test-tmpl.yml
with:
runs-on: "['buildjet-2vcpu-ubuntu-2204-arm']"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use GitHub ARM runner instead of buildjet

uses: ./.github/workflows/functional-tests-tmpl.yml
if: false #Disable buildjet's arm based runners usage.
with:
runs-on: "['buildjet-2vcpu-ubuntu-2204-arm']"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use GitHub ARM runner

README.md Outdated
### If you want to use **latest stable** you can use this one-liner:
```yaml
# Option 1: using 'latest' branch, the most recent CMake and ninja are installed.
- uses: step-security/get-cmake@latest # <--= Just this one-liner suffices.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to set it to the major version, looks like v4

README.md Outdated
# Option 2: or you can use the Git 'tag' to select the version, and you can have a one-liner statement,
# but note that you can only use one of the existing tags, create a PR to add the tag you need!
- name: Get specific version CMake, v3.26.0
uses: step-security/get-cmake@v3.26.0 # <- this one-liner is all you need.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use semantic version of the tag that will be released.

README.md Outdated
# License
All the content in this repository is licensed under the [MIT License](LICENSE).

Copyright (c) 2020-2021-2022-2023-2024-2025 Step Security No newline at end of file
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Include original author and 2025 for StepSecurity

package.json Outdated
"@octokit/plugin-paginate-rest": "^5.0.1",
"@types/jest": "^29.2.0",
"axios": "^1.8.4",
"install": "^0.13.0",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you verify if all the dev dependencies are needed?

Copy link
Copy Markdown
Contributor Author

@amanstep amanstep Apr 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used a tool depcheck which gave the following output

Unused dependencies

  • @actions/exec
  • @types/jest
  • install
  • octokit
  • uuid

Unused devDependencies

  • eslint-plugin-jest
  • ts-node

@varunsh-coder
Copy link
Copy Markdown
Member

Reviewed guarddog findings.

@amanstep amanstep merged commit 8cb9027 into main Apr 24, 2025
58 of 59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants