Rename master branch to main (#255)

* Update contributing guide, remove git-flow references

Signed-off-by: James Hillyerd <james@hillyerd.com>

* Update changelog for main branch rename

Signed-off-by: James Hillyerd <james@hillyerd.com>

* Update github actions for branch rename

* Update README build badges

Signed-off-by: James Hillyerd <james@hillyerd.com>

* Update README for new branch names

Signed-off-by: James Hillyerd <james@hillyerd.com>

* Note branch rename in change log

Signed-off-by: James Hillyerd <james@hillyerd.com>

.github/workflows/docker-build.yml

@@ -1,7 +1,7 @@
 name: Docker Image
 on:
   push:
-    branches: [ "develop" ]
+    branches: [ "main" ]
     tags: [ "v*" ]
   pull_request:
 jobs:
@@ -22,7 +22,7 @@ jobs:
             type=ref,event=pr
             type=semver,pattern={{version}}
             type=sha
-            type=edge,branch=develop
+            type=edge,branch=main
           flavor: |
             latest=auto
       - name: Set up Docker Buildx

.github/workflows/release.yml

@@ -1,7 +1,7 @@
 name: Build and Release
 on:
   push:
-    branches: [ "master", "develop" ]
+    branches: [ "main" ]
     tags: [ "v*" ]
   pull_request:
 jobs:

CHANGELOG.md

@@ -6,6 +6,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Changed
+- Abandoned git-flow process, the `master` branch renamed to `main`
+
 
 ## [v3.0.1-rc1] - 2022-01-17
 
@@ -283,7 +286,8 @@ No change from beta1.
 - Add Link button to messages, allows for directing another person to a
   specific message.
 
-[Unreleased]:   https://github.com/inbucket/inbucket/compare/master...develop
+
+[Unreleased]:   https://github.com/inbucket/inbucket/compare/v3.0.1-rc1...main
 [v3.0.1-rc1]:   https://github.com/inbucket/inbucket/compare/v3.0.0...v3.0.1-rc1
 [v3.0.0]:   https://github.com/inbucket/inbucket/compare/v3.0.0-rc4...v3.0.0
 [v3.0.0-rc4]:   https://github.com/inbucket/inbucket/compare/v3.0.0-rc2...v3.0.0-rc4
@@ -308,16 +312,17 @@ No change from beta1.
 
 ## Release Checklist
 
-1.  Create release branch: `git flow release start 1.x.0`
+1.  Create a release branch
 2.  Update CHANGELOG.md:
     - Ensure *Unreleased* section is up to date
-    - Rename *Unreleased* section to release name and date.
+    - Rename *Unreleased* section to release name and date
     - Add new GitHub `/compare` link
+    - Update previous tag version for *Unreleased* 
 3.  Run tests
 4.  Update goreleaser, and then test cross-compile: `goreleaser --snapshot`
-5.  Commit changes and merge release: `git flow release finish`
+5.  Commit changes and merge release into main, tag `vX.Y.Z`
-6.  Push tags and wait for https://travis-ci.org/inbucket/inbucket build to
+6.  Push tags and wait for
-    complete
+    [GitHub actions](https://github.com/inbucket/inbucket/actions) to complete
 7.  Update `binary_versions` option in `inbucket-site/_config.yml`
 
 See http://keepachangelog.com/ for additional instructions on how to update this file.

CONTRIBUTING.md

@@ -1,11 +1,8 @@
-How to Contribute
+# How to Contribute
-=================
 
 Inbucket encourages third-party patches. It's valuable to know how other
 developers are using the product.
 
-**tl;dr:** File pull requests against the `develop` branch, not `master`!
-
 
 ## Getting Started
 
@@ -17,28 +14,18 @@ to provide validation and/or guidance on your suggested approach.
 
 ## Making Changes
 
-Inbucket uses [git-flow] with default options.  If you have git-flow installed,
+Inbucket follows the regular GitHub pattern. Create a topic branch from where
-you can run `git flow feature start <topic branch name>`.
+you want to base your work:
-
-Without git-flow, create a topic branch from where you want to base your work:
-  - This is usually the `develop` branch, example command:
-    `git checkout origin/develop -b <topic branch name>`
-  - Only target the `master` branch if the issue is already resolved in
-    `develop`.
 
 Once you are on your topic branch:
 
 1. Make commits of logical units.
 2. Add unit tests to exercise your changes.
-3. Run the updated code through `go fmt` and `go vet`.
+3. Run `make` to test, vet and confirm your code is formatted correctly.
-4. Ensure the code builds and tests with the following commands:
+   If you do not have Make installed, please perform these steps manually,
-  - `go clean ./...`
+   otherwise your PR will not pass our checks.
-  - `go build ./...`
-  - `go test ./...`
 
 
 ## Thanks
 
 Thank you for contributing to Inbucket!
-
-[git-flow]: https://github.com/nvie/gitflow

README.md

@@ -1,7 +1,7 @@
-Inbucket
+![Build Status](https://github.com/inbucket/inbucket/actions/workflows/build-and-test.yml/badge.svg)
-=============================================================================
+![Docker Image](https://github.com/inbucket/inbucket/actions/workflows/docker-build.yml/badge.svg)
-[![Build Status](https://travis-ci.org/inbucket/inbucket.png?branch=master)][Build Status]
+
-[![Docker Image](https://github.com/inbucket/inbucket/workflows/Docker%20Image/badge.svg)][Docker Image]
+# Inbucket
 
 Inbucket is an email testing service; it will accept messages for any email
 address and make them available via web, REST and POP3 interfaces.  Once
@@ -26,14 +26,15 @@ to contribute code to the project check out [CONTRIBUTING.md].
 
 ## Docker
 
-Inbucket has automated [Docker Image] builds via Docker Hub.  The `stable` tag
+Inbucket has automated [Docker Image] builds via Docker Hub.  The `latest` tag
-tracks our `master` branch (releases), `latest` tracks our unstable
+tracks our tagged releases, and `edge` tracks our potentially unstable
-`development` branch.
+`main` branch.
 
 
 ## Building from Source
 
-You will need functioning [Go] and [Node.js] installations for this to work.
+You will need functioning [Go], [Elm] and [Node.js] installations for this to
+work.
 
 ```sh
 git clone https://github.com/inbucket/inbucket.git
@@ -72,10 +73,10 @@ Inbucket is open source software released under the MIT License.  The latest
 version can be found at https://github.com/inbucket/inbucket
 
 [Build Status]:           https://travis-ci.org/inbucket/inbucket
-[Change Log]:             https://github.com/inbucket/inbucket/blob/master/CHANGELOG.md
+[Change Log]:             https://github.com/inbucket/inbucket/blob/main/CHANGELOG.md
-[config.md]:              https://github.com/inbucket/inbucket/blob/master/doc/config.md
+[config.md]:              https://github.com/inbucket/inbucket/blob/main/doc/config.md
 [Configurator]:           https://www.inbucket.org/configurator/
-[CONTRIBUTING.md]:        https://github.com/inbucket/inbucket/blob/develop/CONTRIBUTING.md
+[CONTRIBUTING.md]:        https://github.com/inbucket/inbucket/blob/main/CONTRIBUTING.md
 [Development Quickstart]: https://github.com/inbucket/inbucket/wiki/Development-Quickstart
 [Docker Image]:           https://www.inbucket.org/binaries/docker.html
 [Elm]:                    https://elm-lang.org/