Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs improvements #7

Merged
merged 2 commits into from
May 18, 2023
Merged

Docs improvements #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1925091
Add link to options
tmorrell May 17, 2023
4937a07
Update quick-start.md
tmorrell May 17, 2023
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
2 changes: 1 addition & 1 deletion docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
6 changes: 5 additions & 1 deletion docs/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <figure><img src="_static/media/github-tabs.png" width="70%"></figure>
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_<figure><img src="_static/media/github-sidebar-secrets.png" width="30%"></figure>
3. In the next page, click the green <kbd>New repository secret</kbd> button<figure><img src="_static/media/github-secrets.png" width="60%"></figure>
3. In the next page, click the green <kbd>New repository secret</kbd> button<figure><img src="_static/media/github-secrets.png" width="60%"></figure>. 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 <kbd>Add secret</kbd> button

Expand All @@ -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 &ndash; 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.