Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
dd662db
chore: Major refactoring
rsenden Nov 19, 2025
c68ca4a
chore: Update @fortify/setup to 0.0.2
rsenden Nov 19, 2025
783d3ee
chore: Updates
rsenden Nov 21, 2025
7c225e9
chore: Update @fortify/setup
rsenden Nov 21, 2025
7f3fbf7
chore: Various updates
rsenden Nov 21, 2025
7a7798b
chore: Update
rsenden Nov 21, 2025
6f31b8b
chore: Temp update
rsenden Nov 21, 2025
10b96eb
chore: Temp update
rsenden Nov 21, 2025
db0ad13
chore: Temp update
rsenden Nov 21, 2025
53c574f
chore: Temp update
rsenden Nov 21, 2025
2da0332
chore: Updates
rsenden Nov 21, 2025
18b4ac7
chore: Updates
rsenden Nov 21, 2025
7b8d6c2
chore: Update @fortify/setup
rsenden Nov 22, 2025
1b6f3fc
chore: Update dependencies
rsenden Dec 12, 2025
d66d565
chore: Update dependency versions
rsenden Dec 12, 2025
21db4b7
chore: Update @fortify/setup to 0.0.18
rsenden Dec 19, 2025
5f4fbf8
chore: Update dependencies
rsenden Dec 23, 2025
1886e59
Merge pull request #83 from fortify/auto-doc-updates
rsenden Jan 6, 2026
c6fde52
chore: Merge upstream changes
rsenden Jan 6, 2026
7ac3dad
chore: Fix CHANGELOG.md
rsenden Jan 6, 2026
a51a959
chore: Various updates
rsenden Jan 22, 2026
09dce34
chore: Add GITHUB_TOKEN
rsenden Jan 22, 2026
23a86a7
chore: Add --publish option
rsenden Jan 22, 2026
d66c91f
chore: Add --publish option
rsenden Jan 22, 2026
e98a814
chore: Fix action syntax
rsenden Jan 22, 2026
cd7a6bc
chore: tool cache support, @fortify/setup upgrade, doc updates
rsenden Jan 26, 2026
0cfb30b
chore: Update fcli doc links
rsenden Jan 28, 2026
37d6aba
chore: Add debug artifacts, add quickstart
rsenden Feb 3, 2026
a3c25c1
chore: Update fcli doc links
rsenden Feb 3, 2026
bbeffdc
chore: Update setup dependencies
rsenden Feb 7, 2026
1e14427
chore: Doc updates, npm upgrade/audit fix
rsenden Feb 22, 2026
7286439
chore: Update dependency versions
rsenden Feb 23, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,3 @@
## [1.5.1](https://github.com/fortify/github-action/compare/v1.4.0...v1.5.1) (2024-11-01)


### Features

* FoD: Add support for creating application through `DO_SETUP` ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))
* FoD: Automatically set `--app-owner` if `FOD_USER` is configured ([345ddda](https://github.com/fortify/github-action/commit/345ddda04de863b34e9566df5ea088f5872eeef4))
* FoD: Improve handling of `--copy-from` option in `SETUP_EXTRA_OPTS` ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))
* Major documentation usability improvements ([22ea8e9](https://github.com/fortify/github-action/commit/22ea8e9ef9edb24e364d1dc66230649726ad450c))
* Simplify setup of Debricked scans on FoD ([7c25788](https://github.com/fortify/github-action/commit/7c25788b4c57582d2039d70a1ad9aeb228e34c6c))
* Update fcli to 2.9.0 ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))
* Update ScanCentral Client to 24.4.0 ([f3246ac](https://github.com/fortify/github-action/commit/f3246ac1d35a20a34df0a2d404479f1fabeae574))


### Bug Fixes

* Improve parsing of boolean flags in `*_EXTRA_OPTS` ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))
* Update Debricked CLI to 2.1.7 ([2d91e3c](https://github.com/fortify/github-action/commit/2d91e3c5c405391e5ee2cfe725a77b0ded38dcd0))

# Changelog

## [2.2.0](https://github.com/fortify/github-action/compare/v2.1.1...v2.2.0) (2025-11-19)
Expand Down
55 changes: 27 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Fortify GitHub Actions
# Contributing to Fortify GitHub Action

## Contribution Agreement

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

### Repository initialization
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.

### Action documentation
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:

* `action/_generic/**/*`: Generic includes referenced from action documentation
* `action/_root/readme.md`: Documentation for the top-level action
* `action/<action-name>`:
* `readme.md`: Documentation for `<action-name>` sub-action
* `nocomments.env-*.md`: Markdown table rows describing environment variable inputs
* `nocomments.snippet-*.md`: Sample YAML snippets
* `repo-devinfo.md`: Information for developers
* `repo-usage.md`: Used to generated top-level USAGE.md, just refers to README.md
* `template-values.md`: Defines variables used in documentation resources
* `templates/README.template.md`: Template for the top-level `README.md` file
* `templates/<action-name>/README.template.md`: Template for the README.md file for each sub-action
* `update-repo-docs.sh`: Script to generate documentation resources

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.

When adding a new action, you should:
* Create a corresponding directory in the `doc-resources/templates` directory
* Copy an existing `README.template.md` from one of the other action template directories
* Change the header and include statement in the new `README.template.md` to match the new action
* Create a new `action/<action-name>/readme.md` file in the `doc-resources` directory

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.
After cloning this repository, please run `./configure.sh` to install npm modules and configure git hooks.

### Documentation structure
Documentation is generated from the `doc-resources` directory using functionality provided by https://github.com/fortify/shared-doc-resources. The structure is straightforward:

* `repo-intro.md`: Introduction text included in README.md
* `repo-usage.md`: Usage instructions included in USAGE.md
* `repo-resources.md`: Links to resources (contributing, license, etc.)
* `repo-devinfo.md`: Information for developers (this file)
* `repo-usage-text.md`: Include file with links to detailed documentation (used in both intro and usage)
* `template-values.md`: Variables used throughout the documentation
* `update-repo-docs.sh`: Script to regenerate README.md, USAGE.md, and other files

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.

### Building the action

The action uses the `@fortify/setup` NPM package published to [npmjs.org](https://www.npmjs.com/package/@fortify/setup). To build:

```bash
cd setup
npm install
npm run build
```

This creates a bundled `dist/index.js` file that includes all dependencies. The action is ready to use once the dist directory is committed.

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

Expand Down
Loading