xmtop/docs/releasing.md

# Current steps for a release

1. Update Version in main.go 
2. Update CHANGELOG.md
3. Tag
4. Push everything
5. Wait for the github workflows to complete
6. Download and verify the correct version of one of the binaries
7. Finish the draft release and publish.
8. Check gotop-builder for a successful everything build; if successful, publish.
10. Wait for the [AUR](https://github.com/xxxserxxx/gotop-linux) project to finish building.
    1. update arch (gotop-linux) and run `aurpublish gotop` and `aurpublish gotop-bin`
    2. Test install `gotop` and `gotop-bin` with running & version check
11. Notify Nix
12. ~~Notify Homebrew~~ Automated now.

The AUR project still needs secret credentials to aurpublish to the AUR
repository, so the final publish step is still currently manual.

Oh, what a tangled web.


## Nix 

I haven't yet figured this out, so currently just file a ticket and hope somebody on that end updates the package.

Nix adds new and interesting complexities to the release.

0. Download the gotop src package; run sha256 on it to get the hash
1. cd to the nixpkgs directory
2. Update the sha256 hash in `pkgs/tools/system/gotop/default.nix`
2. `docker run -it --rm --mount type=bind,source="\$(pwd)",target=/mnt nixos/nix sh`
3. `cd /mnt`
8. install & run vgo2nix to update deps.nix
7. `nix-build -A gotop`
8. When it fails, ...
Doc changes 2020-06-02 00:08:19 +08:00			`# Current steps for a release`
Adding some dev docs. 2020-02-28 05:44:45 +08:00
			`1. Update Version in main.go`
			`2. Update CHANGELOG.md`
Trying to get the workflow working. 2020-06-08 07:12:04 +08:00			`3. Tag`
			`4. Push everything`
			`5. Wait for the github workflows to complete`
			`6. Download and verify the correct version of one of the binaries`
			`7. Finish the draft release and publish.`
			`8. Check gotop-builder for a successful everything build; if successful, publish.`
[docs] Fix links in docs - 3 Links in colorschemes.md lead to the current docs directory instead of its actual directory in the root - 1 link in releasing.md didnt have the corrent linking syntax causing the link to send the uesr to a page that doesnt exist 2020-11-19 16:32:23 +08:00			`10. Wait for the [AUR](https://github.com/xxxserxxx/gotop-linux) project to finish building.`
Closes #131, SMC GPL issue on OSX; consequently removes need to CGO in darwin. 2020-06-09 22:03:58 +08:00			1. update arch (gotop-linux) and run `aurpublish gotop` and `aurpublish gotop-bin`
			2. Test install `gotop` and `gotop-bin` with running & version check
Trying to get the workflow working. 2020-06-08 07:12:04 +08:00			`11. Notify Nix`
Closes #131, SMC GPL issue on OSX; consequently removes need to CGO in darwin. 2020-06-09 22:03:58 +08:00			`12. ~~Notify Homebrew~~ Automated now.`
resolves #65 Runs tests. Currently, does everything short of initializing the UI, which means it runs the config and plugin code. Currently does not execute any dummy code, such as testing config files etc. 2020-03-02 23:09:17 +08:00
Doc changes 2020-06-02 00:08:19 +08:00			`The AUR project still needs secret credentials to aurpublish to the AUR`
			`repository, so the final publish step is still currently manual.`
resolves #65 Runs tests. Currently, does everything short of initializing the UI, which means it runs the config and plugin code. Currently does not execute any dummy code, such as testing config files etc. 2020-03-02 23:09:17 +08:00
			`Oh, what a tangled web.`
Change Version so it can be set at compile time. @extensions 2020-03-03 19:47:52 +08:00

Doc changes 2020-06-02 00:08:19 +08:00			`## Nix`

			`I haven't yet figured this out, so currently just file a ticket and hope somebody on that end updates the package.`

Change Version so it can be set at compile time. @extensions 2020-03-03 19:47:52 +08:00			`Nix adds new and interesting complexities to the release.`

Switch away from Go Plugin API for the time being. 2020-04-16 21:14:13 +08:00			`0. Download the gotop src package; run sha256 on it to get the hash`
Change Version so it can be set at compile time. @extensions 2020-03-03 19:47:52 +08:00			`1. cd to the nixpkgs directory`
Switch away from Go Plugin API for the time being. 2020-04-16 21:14:13 +08:00			2. Update the sha256 hash in `pkgs/tools/system/gotop/default.nix`
			2. `docker run -it --rm --mount type=bind,source="\$(pwd)",target=/mnt nixos/nix sh`
			3. `cd /mnt`
			`8. install & run vgo2nix to update deps.nix`
			7. `nix-build -A gotop`
Trying to get the workflow working. 2020-06-08 07:12:04 +08:00			`8. When it fails, ...`