Skip to content

Commit efe0c90

Browse files
committed
chore: release action v2.0.0
1 parent 7101459 commit efe0c90

File tree

10 files changed

+101016
-36797
lines changed

10 files changed

+101016
-36797
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is a Github action to update your `codemeta.json`, `CITATION.cff` and `.zenodo.json` files with the release information and then upload your release to Zenodo.
44

5-
This action uses the **tag name** of the release to update the `version` field in the metadata files. Be sure to use the correct tag name. Within your tag name a valid semver version should be present.
5+
This action uses the **tag name** of the release to update the `version` field in the metadata files. Be sure to use the correct tag name. Within your tag name a valid `semver` version should be present.
66

77
When update metadata files are added to your repository, the action will automatically send the new metadata files in its release. This will also mean that your Github release will not contain the updated metadata files. To avoid this, you can set the `update_metadata_files` option to `false` and add a `.zenodo.json` file.
88

@@ -22,6 +22,11 @@ Currently the following files and fields will be updated:
2222
* `.zenodo.json`:
2323
* `version`: The release version
2424

25+
* `docs.compatibility.json`
26+
* A new entry will be added in this file. This entry is meant for versioned Docusaurus projects
27+
* `docsVersion` - The new docs version
28+
* `appVersion` - The latest app version
29+
2530
## Inputs
2631

2732
A list of all inputs to the action is as follows:
@@ -50,6 +55,8 @@ A list of all inputs to the action is as follows:
5055

5156
`zenodo_json` - **Optional** - Whether a `.zenodo.json` file exists in the repository and needs to be updated for the new release. Defaults to `false`.
5257

58+
`docs_compatibility_json` - **Optional** - Whether a `docs.compatibility.json` file exists in the repository and needs to be updated for the new release. Defaults to `false`.
59+
5360
## Outputs
5461

5562
`doi` - The Zenodo DOI of the release.
@@ -81,7 +88,7 @@ jobs:
8188

8289
- name: Upload to Zenodo
8390
id: release
84-
uses: megasanjay/upload-to-zenodo@v1.6.1
91+
uses: megasanjay/upload-to-zenodo@v2.0.0
8592
with:
8693
github_token: ${{ secrets.GITHUB_TOKEN }}
8794
zenodo_token: ${{ secrets.ZENODO_TOKEN }}

action.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ inputs:
5252
description: The JSON file containing the Zenodo metadata
5353
required: false
5454
default: "false"
55+
docs_compatibility_json:
56+
description: The JSON file containing the compatibility documentation
57+
required: false
58+
default: "false"
5559

5660
outputs:
5761
doi:

0 commit comments

Comments
 (0)