Skip to content

Commit

Permalink
Add deploy instructions in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lochhh committed Oct 4, 2024
1 parent b1eaec7 commit c173826
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,28 @@ linkcheck_allowed_redirects = {
r"https://zenodo\.org/doi/.*": r"https://zenodo\.org/records/.*",
}
```
## Deploying the documentation
As mentioned above, the deployment job is triggered whenever a tag is pushed to the main branch. To deploy the documentation, follow these steps:

Fetch all tags:
```bash
git fetch --tags
```

Identify the latest tag:
```bash
git describe --tags
```

Create a new tag:
```bash
git tag <tag_name>
```

Push the tag to the main branch:
```bash
git push origin <tag_name>
```

## Project Aeon Organization Overview

Expand Down

0 comments on commit c173826

Please sign in to comment.