chore: add GitHub Action

.github/workflows/all.yml

@@ -0,0 +1,35 @@
+name: Go Matrix
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+
+jobs:
+
+  cross:
+    name: Go
+    strategy:
+      matrix:
+        go-version: [ stable, oldstable ]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    env:
+      CGO_ENABLED: 1
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Check and get dependencies
+        run: |
+          go mod tidy
+          git diff --exit-code go.mod
+          git diff --exit-code go.sum
+
+      - name: Test
+        run: go test -v -check.vv -race ./...

.github/workflows/pr-only.yml

@@ -0,0 +1,33 @@
+name: PR only
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+
+jobs:
+
+  pr:
+    name: Linting
+    strategy:
+      matrix:
+        go-version: [ stable, oldstable ]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    env:
+      GO_VERSION: stable
+      GOLANGCI_LINT_VERSION: v1.59
+      CGO_ENABLED: 0
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: ${{ env.GOLANGCI_LINT_VERSION }}

LICENSE

@@ -1,3 +1,4 @@
+Copyright (c) 2018-2024, The Gofrs
 Copyright (c) 2015-2020, Tim Heckman
 All rights reserved.
 

README.md

@@ -1,26 +1,30 @@
 # flock
-[![TravisCI Build Status](https://img.shields.io/travis/gofrs/flock/master.svg?style=flat)](https://travis-ci.org/gofrs/flock)
-[![GoDoc](https://img.shields.io/badge/godoc-flock-blue.svg?style=flat)](https://godoc.org/github.com/gofrs/flock)
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/gofrs/flock.svg)](https://pkg.go.dev/github.com/gofrs/flock)
 [![License](https://img.shields.io/badge/license-BSD_3--Clause-brightgreen.svg?style=flat)](https://github.com/gofrs/flock/blob/master/LICENSE)
 [![Go Report Card](https://goreportcard.com/badge/github.com/gofrs/flock)](https://goreportcard.com/report/github.com/gofrs/flock)
 
-`flock` implements a thread-safe sync.Locker interface for file locking. It also
-includes a non-blocking TryLock() function to allow locking without blocking execution.
+`flock` implements a thread-safe sync.Locker interface for file locking.
+It also includes a non-blocking `TryLock()` function to allow locking without blocking execution.
 
 ## License
+
 `flock` is released under the BSD 3-Clause License. See the `LICENSE` file for more details.
 
 ## Go Compatibility
-This package makes use of the `context` package that was introduced in Go 1.7. As such, this
-package has an implicit dependency on Go 1.7+.
+
+This package makes use of the `context` package that was introduced in Go 1.7.
+As such, this package has an implicit dependency on Go 1.7+.
 
 ## Installation
-```
+
+```bash
 go get -u github.com/gofrs/flock
 ```
 
 ## Usage
-```Go
+
+```go
 import "github.com/gofrs/flock"
 
 fileLock := flock.New("/var/lock/go-lock.lock")
@@ -38,4 +42,4 @@ if locked {
 ```
 
 For more detailed usage information take a look at the package API docs on
-[GoDoc](https://godoc.org/github.com/gofrs/flock).
+[GoDoc](https://pkg.go.dev/github.com/gofrs/flock).

flock_aix.go

@@ -13,7 +13,7 @@
 // This code is adapted from the Go package:
 // cmd/go/internal/lockedfile/internal/filelock
 
-//+build aix
+//go:build aix
 
 package flock
 

flock_example_test.go

@@ -16,11 +16,18 @@ import (
 
 func ExampleFlock_Locked() {
 	f := flock.New(os.TempDir() + "/go-lock.lock")
-	f.TryLock() // unchecked errors here
+
+	_, err := f.TryLock()
+	if err != nil {
+		// handle locking error
+	}
 
 	fmt.Printf("locked: %v\n", f.Locked())
 
-	f.Unlock()
+	err = f.Unlock()
+	if err != nil {
+		// handle locking error
+	}
 
 	fmt.Printf("locked: %v\n", f.Locked())
 	// Output: locked: true
@@ -32,7 +39,6 @@ func ExampleFlock_TryLock() {
 	fileLock := flock.New(os.TempDir() + "/go-lock.lock")
 
 	locked, err := fileLock.TryLock()
-
 	if err != nil {
 		// handle locking error
 	}
@@ -54,8 +60,8 @@ func ExampleFlock_TryLockContext() {
 
 	lockCtx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
 	defer cancel()
-	locked, err := fileLock.TryLockContext(lockCtx, 678*time.Millisecond)
 
+	locked, err := fileLock.TryLockContext(lockCtx, 678*time.Millisecond)
 	if err != nil {
 		// handle locking error
 	}

flock_internal_test.go

@@ -1,13 +1,12 @@
 package flock
 
 import (
-	"io/ioutil"
 	"os"
 	"testing"
 )
 
 func Test(t *testing.T) {
-	tmpFileFh, err := ioutil.TempFile(os.TempDir(), "go-flock-")
+	tmpFileFh, err := os.CreateTemp(os.TempDir(), "go-flock-")
 	tmpFileFh.Close()
 	tmpFile := tmpFileFh.Name()
 	os.Remove(tmpFile)

flock_test.go

@@ -7,7 +7,6 @@ package flock_test
 
 import (
 	"context"
-	"io/ioutil"
 	"os"
 	"runtime"
 	"testing"
@@ -28,7 +27,7 @@ var _ = Suite(&TestSuite{})
 func Test(t *testing.T) { TestingT(t) }
 
 func (t *TestSuite) SetUpTest(c *C) {
-	tmpFile, err := ioutil.TempFile(os.TempDir(), "go-flock-")
+	tmpFile, err := os.CreateTemp(os.TempDir(), "go-flock-")
 	c.Assert(err, IsNil)
 	c.Assert(tmpFile, Not(IsNil))
 
@@ -46,36 +45,30 @@ func (t *TestSuite) TearDownTest(c *C) {
 }
 
 func (t *TestSuite) TestNew(c *C) {
-	var f *flock.Flock
-
-	f = flock.New(t.path)
+	f := flock.New(t.path)
 	c.Assert(f, Not(IsNil))
 	c.Check(f.Path(), Equals, t.path)
 	c.Check(f.Locked(), Equals, false)
 	c.Check(f.RLocked(), Equals, false)
 }
 
 func (t *TestSuite) TestFlock_Path(c *C) {
-	var path string
-	path = t.flock.Path()
+	path := t.flock.Path()
 	c.Check(path, Equals, t.path)
 }
 
 func (t *TestSuite) TestFlock_Locked(c *C) {
-	var locked bool
-	locked = t.flock.Locked()
+	locked := t.flock.Locked()
 	c.Check(locked, Equals, false)
 }
 
 func (t *TestSuite) TestFlock_RLocked(c *C) {
-	var locked bool
-	locked = t.flock.RLocked()
+	locked := t.flock.RLocked()
 	c.Check(locked, Equals, false)
 }
 
 func (t *TestSuite) TestFlock_String(c *C) {
-	var str string
-	str = t.flock.String()
+	str := t.flock.String()
 	c.Assert(str, Equals, t.path)
 }
 

flock_unix.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by the BSD 3-Clause
 // license that can be found in the LICENSE file.
 
-// +build !aix,!windows
+//go:build !aix && !windows
 
 package flock
 
@@ -171,8 +171,9 @@ retry:
 
 // reopenFDOnError determines whether we should reopen the file handle
 // in readwrite mode and try again. This comes from util-linux/sys-utils/flock.c:
-//  Since Linux 3.4 (commit 55725513)
-//  Probably NFSv4 where flock() is emulated by fcntl().
+//
+//	Since Linux 3.4 (commit 55725513)
+//	Probably NFSv4 where flock() is emulated by fcntl().
 func (f *Flock) reopenFDOnError(err error) (bool, error) {
 	if err != syscall.EIO && err != syscall.EBADF {
 		return false, nil

flock_winapi.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by the BSD 3-Clause
 // license that can be found in the LICENSE file.
 
-// +build windows
+//go:build windows
 
 package flock