Features β
- Supports files up to 650MB
- Upload Release Assets or File Globs
- Automatically add Results to Release Notes
- Customize Release Notes Heading
- Rate Limited for Free Accounts
- Option to specify the Release ID
Planned
- Add options to customize release update/output format (next on the roadmap)
- Add release body parsing to properly process new files on edited activity
- Add option to apply file_globs to release assets
Request a Feature
Please help us by submitting a feature request.
Release Notes β
If run on a release event, the Release Notes are automatically updated with the results unless you set update_release
to false
. You can customize the heading or remove it by specifying an empty string.
Example Release Notes.
π‘οΈ VirusTotal Results:
Job Summary β
Unless disabled, a Job Summary is generated to capture the command, output and errors.
View Job Summary
File | ID |
---|---|
README.md | YmFmZTVlZjIzMDRkMjRlMTcwNjk1Yzg0MTgyN2FmMmM6MTc0MjExMjY5Mw== |
.gitignore | ZTM4MjBkOGFhYmRhNjBiMTY0MTEwZjZkNDE1YjViODc6MTc0MjExMjY5Mw== |
Outputs
[
{
"id": "YmFmZTVlZjIzMDRkMjRlMTcwNjk1Yzg0MTgyN2FmMmM6MTc0MjExMjY5Mw==",
"name": "README.md",
"link": "https://www.virustotal.com/gui/file-analysis/YmFmZTVlZjIzMDRkMjRlMTcwNjk1Yzg0MTgyN2FmMmM6MTc0MjExMjY5Mw=="
},
{
"id": "ZTM4MjBkOGFhYmRhNjBiMTY0MTEwZjZkNDE1YjViODc6MTc0MjExMjY5Mw==",
"name": ".gitignore",
"link": "https://www.virustotal.com/gui/file-analysis/ZTM4MjBkOGFhYmRhNjBiMTY0MTEwZjZkNDE1YjViODc6MTc0MjExMjY5Mw=="
}
]
README.md/YmFmZTVlZjIzMDRkMjRlMTcwNjk1Yzg0MTgyN2FmMmM6MTc0MjExMjY5Mw==
.gitignore/ZTM4MjBkOGFhYmRhNjBiMTY0MTEwZjZkNDE1YjViODc6MTc0MjExMjY5Mw==
Config
files: ["README.md",".gitignore"]
rate: 4
update: true
heading: "π‘οΈ **VirusTotal Results:**"
summary: true
You can view an actual workflow run from the Test job on GitHub (requires login).
Rolling Tags β
The following rolling tags are maintained to improve stability across updates.
VersionΒ Tag | Rolling | Bugs | Feat. | Name | Target | Example |
---|---|---|---|---|---|---|
β | β | β | Major | vN.x.x | vN | |
β | β | β | Minor | vN.N.x | vN.N | |
β | β | β | Micro | vN.N.N | vN.N.N |
You can view the release notes for each version on the releases page.
The Major tag is recommended. It is the most up-to-date and always backwards compatible. Breaking changes would result in a Major version bump. At a minimum you should use a Minor tag.
Tags Security Notice β
As shown above, tags are mutable; however, commit hashes are not. Therefore, if security is your top priority, you should pin your actions to a specific commit hash.
VirusTotal Badges β
We are also working on a Badge Server (similar to shields.io) supporting VirusTotal.
- From a File Hash or VirusTotal File ID
- From a GitHub Release Asset using Latest or a Tag
For more details see the Website, the README.md or the Discussion.
These badges may be eventually added to this action as an option for release notes. Any feedback is helpful during this phase of development.