Skip to content

Commit 2fd053e

Browse files
committed
Updates for deprecations in goreleaser.
Update goreleaser configuration and example update script to deal with deprecation notices. Modify readme to conform to the new format standards. Include deprecation notices in the readme.
1 parent b3e860c commit 2fd053e

4 files changed

Lines changed: 14 additions & 21 deletions

File tree

.github/workflows/goreleaser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
# either 'goreleaser' (default) or 'goreleaser-pro'
3434
distribution: goreleaser
3535
version: latest
36-
args: release --rm-dist
36+
args: release --clean
3737
env:
3838
GITHUB_TOKEN: ${{ secrets.GIT_PAT }}
3939
GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}

.goreleaser.yml

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,20 +48,7 @@ builds:
4848
goarch: 386
4949
archives:
5050
-
51-
replacements:
52-
darwin: macOS
53-
linux: Linux
54-
windows: Windows
55-
freebsd: FreeBSD
56-
netbsd: NetBSD
57-
openbsd: OpenBSD
58-
plan9: Plan9
59-
dragonfly: DragonFly
60-
solaris: Solaris
61-
aix: AIX
62-
386: i386
63-
amd64: x86_64
64-
arm64: aarch64
51+
rlcp: true
6552
format_overrides:
6653
- goos: windows
6754
format: zip
@@ -88,6 +75,7 @@ changelog:
8875
- '^docs:'
8976
- '^release:'
9077
source:
78+
rlcp: true
9179
enabled: true
9280
name_template: "{{ .ProjectName }}_source"
9381
format: "tar.gz"

README.MD

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,25 @@ My goals for this project are to create a stable server for the NVDARemote addon
2323

2424
On the [releases](https://github.com/tech10/nvdaRemoteServer/releases) page, there are compiled binaries for various operating systems and architectures that Go supports. I have made an effort to ensure each binary is a completely static build, and thus, not dependent on any libraries that may or may not be used in different operating systems upon which the program can be run. Since there are numerous systems and configurations available for use, the download and installation of the server's binary builds won't be completely covered in this documentation.
2525

26+
Due to some recent deprecation notices in Goreleaser, the following changes have been made to the archive file format, which will take effect on the next release.
27+
28+
- The architecture format has changed. Most notibly, x86_64 is now amd64, i386 is 386, aarch64 is arm64.
29+
- Operating system formats have been changed. For the most part, the capital letters have been removed from the operating system formats. Windows is windows, OpenBSD is openbsd, etc. The most significant of these changes is that macOS will be replaced with darwin. Any scripts that update the server from the GitHub releases will need to be updated accordingly, so as to reflect these changes.
30+
2631
Some basic instructions to download and use the binary on Linux using a x86_64 architecture would be the following, for example.
2732

2833
```console
2934
# Assume wget is installed.
3035
# First, download the latest archive.
31-
$ wget https://github.com/tech10/nvdaRemoteServer/releases/latest/download/nvdaRemoteServer_Linux_x86_64.tar.gz
36+
$ wget https://github.com/tech10/nvdaRemoteServer/releases/latest/download/nvdaRemoteServer_linux_amd64.tar.gz
3237
# Use tar to extract the archive and change to the directory.
33-
$ tar -axf ./nvdaRemoteServer_Linux_x86_64.tar.gz
34-
$ cd ./nvdaRemoteServer_Linux_x86_64
38+
$ tar -axf ./nvdaRemoteServer_linux_amd64.tar.gz
39+
$ cd ./nvdaRemoteServer_linux_amd64
3540
# Copy the binary to the users bin directory, for example.
3641
$ cp -a ./nvdaRemoteServer ~/bin/
3742
# Clean up after yourself by removing what you don't need.
3843
$ cd ../
39-
$ rm -r ./nvdaRemoteServer_Linux_x86_64*
44+
$ rm -r ./nvdaRemoteServer_linux_amd64*
4045
```
4146

4247
A sample systemd service file is also available within the archive, which is for use on systems using systemd. Configuration of systemd with this server is outside the scope of this documentation, as there are numerous configurations available for use with systemd.

update-nvdaRemoteServer.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
# and are using systemd for your daemon manager. This will automatically download the latest release.
55
# Modify the appropriate variables for your system, and commands, if needed.
66
binary="nvdaRemoteServer"
7-
os="Linux"
8-
arch="x86_64"
7+
os="linux"
8+
arch="amd64"
99
program="${binary}_${os}_${arch}"
1010
check() {
1111
eval $@

0 commit comments

Comments
 (0)