diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml index 899671a..82baf48 100644 --- a/.github/workflows/run_tests.yml +++ b/.github/workflows/run_tests.yml @@ -7,7 +7,6 @@ on: push: branches: [ "main" ] pull_request: - branches: [ "main", "release/**", "develop" ] permissions: contents: read diff --git a/CHANGELOG.md b/CHANGELOG.md index 9cfcb63..91dd5f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ # Changelog +## Unreleased +* The project is now following the [Github Flow](https://docs.github.com/en/get-started/using-git-and-github/github-flow) branching model. The `main` branch is now the default branch, and the `develop` branch has been removed. Future development should create a new branch directly from `main`, and when done, creating a pull request back into `main`. Releases should be tagged directly on `main` as well. + ## [v2.0.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v2.0.0) (2024-03-06) ### Breaking changes diff --git a/LICENSE b/LICENSE index e32aaca..c55a2d8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Salling Group A/S +Copyright (c) 2023-2025 Salling Group A/S Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index da07c6c..3d00d58 100644 --- a/README.md +++ b/README.md @@ -168,12 +168,13 @@ To contribute, clone the repo and create a branch, create a virtual environment ```console $ pytest . ``` -then create a pull request for the `develop` branch. +then create a pull request for the `main` branch. Every (public) subcommand has its own test file `tests/test_venv_.py` Please make sure to add/update tests as appropriate. -### Git Flow -This project follows the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model. The default development branch is accordingly named `develop`, and the branch `main` is reserved for tagged releases and hotfixes. Other branches should be named according to their purpose: +### Branches +When creating a new branch, please prefix them with one of the following: + ``` feature/ bugfix/ @@ -182,7 +183,8 @@ hotfix/ support/ ``` -Releases are made by creating a branch `release/vX.X.X` from `develop`, where `X.X.X` represents the release version number, following [SemVer](https://semver.org/). This freezes the version number of **this release**, and no more features from `develop` should be merged into this release (only `bugfix/`). When the `release/` branch is ready for release, merge it into `main` and tag the commit with the release version, then merge the `release/` branch back into `develop` (resolving any merge conflicts) to get the bugfixes included there as well. +Releases are made by simply tagging a release commit on the `main` branch, then creating a GitHub release from that tag. +The release tag should be a SemVer compliant tag, prefixed by `v`, e.g. `v1.2.3`. ## License