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.

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

Documentation/Tech: 3756/release script on windows #3811

Merged
merged 2 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 DEV_START_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ All major decisions are documented in our [architecture decision records (ADR)](

To work on CodeCharta, please ensure your system includes:

- Git
- Git (with bash utilities for Windows)
- Java >= 11, <= 21
- Node >= 20

Expand Down
2 changes: 1 addition & 1 deletion VERSION_BUMPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For the Visualization release, the project must be built, so it is advisable to
## Start the automatic release process

- Call `pipenv run make_release`.
- On Windows it is recommended to run the command in `cmd.exe` rather than in a git bash.
- **On Windows**: Make sure that the git bash utilities are on your path variable if you are using the `cmd`. Alternatively, you can use the git `bash` directly.
- Check the release process on GitHub after the script is completed

> You can add `-f` or `--force` to disable the protections of the script. You can't release in force mode.
Expand Down
2 changes: 2 additions & 0 deletions visualization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ $ codecharta-visualization

> To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (version >=20) installed
> (Windows) For some tasks the Git bash utilities are required
```bash
# Clone the CodeCharta repo
$ git clone https://github.com/MaibornWolff/codecharta.git
Expand Down
Loading