diff --git a/docs/installation.md b/docs/installation.md index fab30ac..7aeafda 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -103,7 +103,7 @@ A [GitHub Action](https://docs.github.com/en/actions) is a workflow that runs on release_tag: ${{github.event.inputs.release_tag || 'latest'}} ``` 3. **Edit the value of the `INVENIO_SERVER` variable (line 4 above)** ↑ -4. Optionally, change the values of other options (`all_assets`, `community`, etc.) +4. Optionally, change the [values of other options (`all_assets`, `community`, etc.)](https://caltechlibrary.github.io/iga/gha-usage.html#input-parameters) 5. Save the file, commit the changes to git, and push your changes to GitHub The sample `.yml` workflow file above is also available from the GitHub repository for IGA as file [`sample-workflow.yml`](https://github.com/caltechlibrary/iga/blob/main/sample-workflow.yml). diff --git a/docs/quick-start.md b/docs/quick-start.md index 3613271..6e48969 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -63,7 +63,7 @@ After doing the [GitHub Action installation](installation.md) steps and [obtaini 1. Go to the _Settings_ page of your GitHub repository
2. In the left-hand sidebar, find _Secrets and variables_ in the Security section, click on it to reveal _Actions_ underneath, then click on _Actions_
-3. In the next page, click the green New repository secret button
+3. In the next page, click the green New repository secret button
. Alternatively, if you are part of a GitHub organization you can add a secret for all organizational repositories by clicking the grey "Manage organization secrets" button. 4. Name the variable `INVENIO_TOKEN` and paste in your InvenioRDM token 5. Finish by clicking the green Add secret button @@ -82,3 +82,7 @@ After setting up the workflow and storing the InvenioRDM token in your repositor ### Running the workflow when releasing software Once the personal access token from InvenioRDM is stored as a GitHub secret, the workflow should run automatically every time a new release is made on GitHub – no further action should be needed. You can check the results (and look for errors if something went wrong) by going to the _Actions_ tab in your GitHub repository. + +### After the first release + +Once you've made the first release of your software on InvenioRDM, you might want to add the record you created as a 'parent'. This will enable automatic versioning, so all your software versions will be listed in one place and users will be notified about newer versions of the software. Grab the record id at the end of your InvenioRDM record (e.g. 6qhkm-7n074) and add it to your `iga.yml` file in the `parent_record` field.