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

GRIDEDIT-1421: Improve_documentation #35

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GRIDEDIT-1421: Improve_documentation #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,31 @@ This repository contains bash and python scripts for the the release automation
## Usage

It is assumed below that the release script is run from the root directory of the repository.
It is also assumed that Miniconda or Anaconda is installed on your Linux distribution.

To display the usage, use

```bash
./scripts/automation/release.sh --help
```
The file `./scripts/globals.sh` contains global variables used across all scripts. To work with test branches
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The forked repositories must be removed, particularly private ones, and so are the associated TeamCity sub-projects. They clutter the parent project. It does not make sense to leave there forever. They were there for development purposes.

Also notice that that the jobs that generate nupkgs from the forks, have the exact same name prefixes as the real nupkgs, and end up in the package repository. That's bad. They are visible in visual studio through the nuget manager.

and simulate a release, set the `repo_owner` and `forked_repo_suffix` variables as follows:

```bash
declare -g repo_owner="Deltares-research"
declare -g forked_repo_suffix="Test"
```
To work with production branches, set the `repo_owner` and `forked_repo_suffix` variables as follows:
```bash
declare -g repo_owner="Deltares"
declare -g forked_repo_suffix=""
```
The scripts clone Git repositories using SSH. To use SSH with `git clone`, you must set up SSH keys in your
GitHub account under **Settings** > **SSH and GPG keys**.
Additionally, Single Sign-On (SSO) must be configured for the key to authorize the Deltares and Deltares-Research organizations.

GitHub tokens can be managed under **GitHub account** > **Developer settings** > **Personal access tokens** (classic). When generating a new token, ensure that SSO is configured to authorize Deltares and Deltares-Research.
Comment on lines +27 to +31
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be moved to dedicated section, "Requirements". The section should address 3 things:

  1. GitHub ssh key ad access token (above)
  2. TeamCity token
  3. PyPi token



Usage:

Expand Down