Skip to content

Commit 51c4a83

Browse files
authored
Prepare for GitHub Action v3.0.0 release (#85)
feat!: `fortify/github-action/setup`: Now uses `@fortify/setup` NPM component instead of GitHub-specific implementation, resulting in changes to supported action inputs and environment variables feat!: `fortify/github-action`: Now uses `fcli action run ci` instead of GitHub-specific scripts, resulting in changes to supported action inputs and environment variables feat!: `fortify/github-action/*`: All sub-actions except for the `setup` action have been removed; use the top-level `fortify/github-action` to run a full AST scan pipeline, or use the `setup` action in combination with `fcli` commands or actions to implement custom workflows
1 parent 8b0a310 commit 51c4a83

127 files changed

Lines changed: 1317 additions & 26220 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,3 @@
1-
## [1.5.1](https://github.com/fortify/github-action/compare/v1.4.0...v1.5.1) (2024-11-01)
2-
3-
4-
### Features
5-
6-
* FoD: Add support for creating application through `DO_SETUP` ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))
7-
* FoD: Automatically set `--app-owner` if `FOD_USER` is configured ([345ddda](https://github.com/fortify/github-action/commit/345ddda04de863b34e9566df5ea088f5872eeef4))
8-
* FoD: Improve handling of `--copy-from` option in `SETUP_EXTRA_OPTS` ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))
9-
* Major documentation usability improvements ([22ea8e9](https://github.com/fortify/github-action/commit/22ea8e9ef9edb24e364d1dc66230649726ad450c))
10-
* Simplify setup of Debricked scans on FoD ([7c25788](https://github.com/fortify/github-action/commit/7c25788b4c57582d2039d70a1ad9aeb228e34c6c))
11-
* Update fcli to 2.9.0 ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))
12-
* Update ScanCentral Client to 24.4.0 ([f3246ac](https://github.com/fortify/github-action/commit/f3246ac1d35a20a34df0a2d404479f1fabeae574))
13-
14-
15-
### Bug Fixes
16-
17-
* Improve parsing of boolean flags in `*_EXTRA_OPTS` ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))
18-
* Update Debricked CLI to 2.1.7 ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))
19-
201
# Changelog
212

223
## [2.2.0](https://github.com/fortify/github-action/compare/v2.1.1...v2.2.0) (2025-11-19)

CONTRIBUTING.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to Fortify GitHub Actions
1+
# Contributing to Fortify GitHub Action
22

33
## Contribution Agreement
44

@@ -10,33 +10,32 @@ Contributions like bug fixes and enhancements may be submitted through Pull Requ
1010
## Information for Developers
1111

1212
### Repository initialization
13-
After cloning this repository, please run ./configure.sh to install npm modules and configure git hooks. When adding a new NodeJS-based action, you'll need to update `<repo-root>/configure.sh` to add the action directory to the for-loop.
14-
15-
### Action documentation
16-
Action documentation is generated from the `doc-resources` directory, using functionality provided by https://github.com/fortify/shared-doc-resources. The `doc-resources` directory contains the following:
17-
18-
* `action/_generic/**/*`: Generic includes referenced from action documentation
19-
* `action/_root/readme.md`: Documentation for the top-level action
20-
* `action/<action-name>`:
21-
* `readme.md`: Documentation for `<action-name>` sub-action
22-
* `nocomments.env-*.md`: Markdown table rows describing environment variable inputs
23-
* `nocomments.snippet-*.md`: Sample YAML snippets
24-
* `repo-devinfo.md`: Information for developers
25-
* `repo-usage.md`: Used to generated top-level USAGE.md, just refers to README.md
26-
* `template-values.md`: Defines variables used in documentation resources
27-
* `templates/README.template.md`: Template for the top-level `README.md` file
28-
* `templates/<action-name>/README.template.md`: Template for the README.md file for each sub-action
29-
* `update-repo-docs.sh`: Script to generate documentation resources
30-
31-
If you need to update the documentation for an existing action, you'll want to edit the corresponding `action/<action-name>/readme.md` file or the included files.
32-
33-
When adding a new action, you should:
34-
* Create a corresponding directory in the `doc-resources/templates` directory
35-
* Copy an existing `README.template.md` from one of the other action template directories
36-
* Change the header and include statement in the new `README.template.md` to match the new action
37-
* Create a new `action/<action-name>/readme.md` file in the `doc-resources` directory
38-
39-
After any documentation updates, you may want to manually run `doc-resources/update-repo-docs.sh` to verify whether all includes can be found, and to review the generated README.md files for each action.
13+
After cloning this repository, please run `./configure.sh` to install npm modules and configure git hooks.
14+
15+
### Documentation structure
16+
Documentation is generated from the `doc-resources` directory using functionality provided by https://github.com/fortify/shared-doc-resources. The structure is straightforward:
17+
18+
* `repo-intro.md`: Introduction text included in README.md
19+
* `repo-usage.md`: Usage instructions included in USAGE.md
20+
* `repo-resources.md`: Links to resources (contributing, license, etc.)
21+
* `repo-devinfo.md`: Information for developers (this file)
22+
* `repo-usage-text.md`: Include file with links to detailed documentation (used in both intro and usage)
23+
* `template-values.md`: Variables used throughout the documentation
24+
* `update-repo-docs.sh`: Script to regenerate README.md, USAGE.md, and other files
25+
26+
To update documentation, edit the appropriate `.md` files in `doc-resources/`, then run `doc-resources/update-repo-docs.sh` to regenerate the top-level documentation files.
27+
28+
### Building the action
29+
30+
The action uses the `@fortify/setup` NPM package published to [npmjs.org](https://www.npmjs.com/package/@fortify/setup). To build:
31+
32+
```bash
33+
cd setup
34+
npm install
35+
npm run build
36+
```
37+
38+
This creates a bundled `dist/index.js` file that includes all dependencies. The action is ready to use once the dist directory is committed.
4039

4140
<!-- END-INCLUDE:repo-devinfo.md -->
4241

0 commit comments

Comments
 (0)