chore(release): 0.6.8

Stable builds are based off of release git tags in Emacs' git
repo. Examples of what release tags look like:

- emacs-26.1
- emacs-26.2
- emacs-26.3
- emacs-27.1
- emacs-27.2

When the specified git ref looks like a stable release, the plan command
will generate a release a different and simpler release name that does
not include the date, git sha or ref. Instead, for "emacs-27.2" for
example, the emacs-builds release name will be "Emacs-27.2".

The "build name", used for naming the disk image, still retains the same
format as the nightly builds.

Also, non-stable releases are now marked as pre-release on GitHub by
default.

The reason for the different release name format for stable builds is
both to separate them, but also to make it easier to keep the version of
the homebrew cask as simply "27.2".

CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.6.8](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.7...v0.6.8) (2021-07-02)
+
+
+### Features
+
+* **builds:** add support for stable builds ([f4d6e3a](https://github.com/jimeh/build-emacs-for-macos/commit/f4d6e3a56d2c15b0c86af18e8d16bebbeb92a8ab))
+
+### [0.6.7](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.6...v0.6.7) (2021-07-02)
+
+
+### Features
+
+* **bundle:** move bundled shared libraries to Contents/Frameworks ([5c722e3](https://github.com/jimeh/build-emacs-for-macos/commit/5c722e36c571aa7bf558b7f210c011f12d8d8a1c))
+
 ### [0.6.6](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.5...v0.6.6) (2021-07-01)
 
 ### [0.6.5](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.4...v0.6.5) (2021-07-01)

build-emacs-for-macos

@@ -11,6 +11,7 @@ require 'net/http'
 require 'optparse'
 require 'pathname'
 require 'time'
+require 'tmpdir'
 require 'uri'
 require 'yaml'
 
@@ -735,8 +736,6 @@ class AbstractEmbedder
     @app = app
   end
 
-  private
-
   def invocation_dir
     File.join(app, 'Contents', 'MacOS')
   end
@@ -746,7 +745,7 @@ class AbstractEmbedder
   end
 
   def lib_dir
-    File.join(invocation_dir, 'lib')
+    File.join(app, 'Contents', 'Frameworks')
   end
 end
 
@@ -902,15 +901,15 @@ class GccLibEmbedder < AbstractEmbedder
   end
 
   def target_dir
-    File.join(invocation_dir, gcc_info.relative_lib_dir)
+    File.join(lib_dir, gcc_info.relative_lib_dir)
   end
 
   def source_darwin_dir
-    File.join(invocation_dir, gcc_info.relative_darwin_lib_dir)
+    File.join(lib_dir, gcc_info.relative_darwin_lib_dir)
   end
 
   def target_darwin_dir
-    File.join(invocation_dir, gcc_info.sanitized_relative_darwin_lib_dir)
+    File.join(lib_dir, gcc_info.sanitized_relative_darwin_lib_dir)
   end
 
   def source_dir
@@ -966,7 +965,21 @@ class GccInfo
   def sanitized_relative_darwin_lib_dir
     @sanitized_relative_darwin_lib_dir ||= File.join(
       File.dirname(relative_darwin_lib_dir),
-      File.basename(relative_darwin_lib_dir).split('.').first
+      File.basename(relative_darwin_lib_dir).gsub('.', '_')
+    )
+  end
+
+  def app_bundle_relative_lib_dir
+    @app_bundle_relative_lib_dir ||= relative_dir(
+      File.join(embedder.lib_dir, relative_lib_dir),
+      embedder.invocation_dir
+    )
+  end
+
+  def app_bundle_relative_darwin_lib_dir
+    @app_bundle_relative_darwin_lib_dir ||= relative_dir(
+      File.join(embedder.lib_dir, sanitized_relative_darwin_lib_dir),
+      embedder.invocation_dir
     )
   end
 
@@ -1013,6 +1026,10 @@ class GccInfo
 
   private
 
+  def embedder
+    @embedder ||= AbstractEmbedder.new(Dir.mktmpdir(['Emacs', '.app']))
+  end
+
   def relative_dir(path, root)
     Pathname.new(path).relative_path_from(Pathname.new(root)).to_s
   end

patches/native-comp-env-setup.diff.erb

@@ -1,8 +1,8 @@
 diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el
-index 8c638312b0..87af889ef4 100644
+index 638d4b274c..2599211936 100644
 --- a/lisp/emacs-lisp/comp.el
 +++ b/lisp/emacs-lisp/comp.el
-@@ -4215,6 +4215,52 @@ native-compile-async
+@@ -4224,6 +4224,52 @@ native-compile-async
    (let ((load (not (not load))))
      (native--compile-async files recursively load selector)))
  
@@ -16,10 +16,10 @@ index 8c638312b0..87af889ef4 100644
 +           (devtools-dir
 +            "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib")
 +           (gcc-dir (expand-file-name
-+                     "<%= relative_lib_dir %>"
++                     "<%= app_bundle_relative_lib_dir %>"
 +                     invocation-directory))
 +           (darwin-dir (expand-file-name
-+                        "<%= sanitized_relative_darwin_lib_dir %>"
++                        "<%= app_bundle_relative_darwin_lib_dir %>"
 +                        invocation-directory))
 +           (lib-paths (list)))
 +

pkg/cask/update.go

@@ -19,6 +19,7 @@ import (
 	"github.com/hexops/gotextdiff/myers"
 	"github.com/hexops/gotextdiff/span"
 	"github.com/jimeh/build-emacs-for-macos/pkg/gh"
+	"github.com/jimeh/build-emacs-for-macos/pkg/release"
 	"github.com/jimeh/build-emacs-for-macos/pkg/repository"
 )
 
@@ -363,9 +364,14 @@ func (s *Updater) renderCask(
 	ctx context.Context,
 	chk *LiveCheck,
 ) ([]byte, error) {
-	releaseName := "Emacs." + chk.Version.Latest
+	releaseName, err := release.VersionToName(chk.Version.Latest)
+	if err != nil {
+		return nil, err
+	}
 
-	s.logger.Info("fetching release details", "release", releaseName)
+	s.logger.Info("fetching release details",
+		"release", releaseName, "repo", s.BuildsRepo.URL(),
+	)
 	release, resp, err := s.gh.Repositories.GetReleaseByTag(
 		ctx, s.BuildsRepo.Owner(), s.BuildsRepo.Name(), releaseName,
 	)

pkg/plan/create.go

@@ -11,6 +11,7 @@ import (
 	"github.com/jimeh/build-emacs-for-macos/pkg/commit"
 	"github.com/jimeh/build-emacs-for-macos/pkg/gh"
 	"github.com/jimeh/build-emacs-for-macos/pkg/osinfo"
+	"github.com/jimeh/build-emacs-for-macos/pkg/release"
 	"github.com/jimeh/build-emacs-for-macos/pkg/repository"
 )
 
@@ -64,15 +65,17 @@ func Create(ctx context.Context, opts *Options) (*Plan, error) {
 		return nil, err
 	}
 
-	releaseName := fmt.Sprintf(
+	version := fmt.Sprintf(
-		"Emacs.%s.%s.%s",
+		"%s.%s.%s",
 		commitInfo.DateString(),
 		commitInfo.ShortSHA(),
 		sanitizeString(opts.Ref),
 	)
+
+	releaseName := fmt.Sprintf("Emacs.%s", version)
 	buildName := fmt.Sprintf(
-		"%s.%s.%s",
+		"Emacs.%s.%s.%s",
-		releaseName,
+		version,
 		sanitizeString(osInfo.Name+"-"+osInfo.MajorMinor()),
 		sanitizeString(osInfo.Arch),
 	)
@@ -92,7 +95,8 @@ func Create(ctx context.Context, opts *Options) (*Plan, error) {
 		},
 		OS: osInfo,
 		Release: &Release{
-			Name: releaseName,
+			Name:       releaseName,
+			Prerelease: true,
 		},
 		Output: &Output{
 			Directory: opts.OutputDir,
@@ -100,6 +104,16 @@ func Create(ctx context.Context, opts *Options) (*Plan, error) {
 		},
 	}
 
+	// If given git ref is a stable release tag (emacs-23.2b, emacs-27.2, etc.)
+	// we modify release properties accordingly.
+	if v, err := release.GitRefToStableVersion(opts.Ref); err == nil {
+		plan.Release.Prerelease = false
+		plan.Release.Name, err = release.VersionToName(v)
+		if err != nil {
+			return nil, err
+		}
+	}
+
 	if opts.TestBuild != "" {
 		testName := sanitizeString(opts.TestBuild)
 

pkg/release/version.go

@@ -0,0 +1,42 @@
+package release
+
+import (
+	"errors"
+	"fmt"
+	"regexp"
+)
+
+// Errors
+var (
+	Err             = errors.New("release")
+	ErrInvalidName  = fmt.Errorf("%w: invalid name", Err)
+	ErrEmptyVersion = fmt.Errorf("%w: empty version", Err)
+	ErrNotStableRef = fmt.Errorf(
+		"%w: git ref is not stable tagged release", Err,
+	)
+)
+
+var (
+	stableVersion = regexp.MustCompile(`^\d+\.\d+(?:[a-z]+)?$`)
+	stableGetRef  = regexp.MustCompile(`^emacs-(\d+\.\d+(?:[a-z]+)?)$`)
+)
+
+func VersionToName(version string) (string, error) {
+	if version == "" {
+		return "", ErrEmptyVersion
+	}
+
+	if stableVersion.MatchString(version) {
+		return "Emacs-" + version, nil
+	}
+
+	return "Emacs." + version, nil
+}
+
+func GitRefToStableVersion(ref string) (string, error) {
+	if m := stableGetRef.FindStringSubmatch(ref); len(m) > 1 {
+		return m[1], nil
+	}
+
+	return "", fmt.Errorf("%w: \"%s\"", ErrNotStableRef, ref)
+}

pkg/release/version_test.go

@@ -0,0 +1,138 @@
+package release
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestVersionToName(t *testing.T) {
+	type args struct {
+		version string
+	}
+	tests := []struct {
+		name    string
+		args    args
+		want    string
+		wantErr string
+	}{
+		{
+			name: "empty",
+			args: args{
+				version: "",
+			},
+			wantErr: "release: empty version",
+		},
+		{
+			name: "nightly",
+			args: args{
+				version: "2021-07-01.1b88404.master",
+			},
+			want: "Emacs.2021-07-01.1b88404.master",
+		},
+		{
+			name: "stable",
+			args: args{
+				version: "27.2",
+			},
+			want: "Emacs-27.2",
+		},
+		{
+			name: "stable with letter",
+			args: args{
+				version: "23.3b",
+			},
+			want: "Emacs-23.3b",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := VersionToName(tt.args.version)
+
+			assert.Equal(t, tt.want, got)
+
+			if tt.wantErr != "" {
+				assert.EqualError(t, err, tt.wantErr)
+			} else {
+				assert.NoError(t, err)
+			}
+		})
+	}
+}
+
+func TestGitRefToStableVersion(t *testing.T) {
+	type args struct {
+		version string
+	}
+	tests := []struct {
+		name    string
+		args    args
+		want    string
+		wantErr string
+	}{
+		{
+			name: "empty",
+			args: args{
+				version: "",
+			},
+			wantErr: "release: git ref is not stable tagged release: \"\"",
+		},
+		{
+			name: "master",
+			args: args{
+				version: "master",
+			},
+			wantErr: "release: git ref is not stable tagged release: " +
+				"\"master\"",
+		},
+		{
+			name: "feature",
+			args: args{
+				version: "feature/native-comp",
+			},
+			wantErr: "release: git ref is not stable tagged release: " +
+				"\"feature/native-comp\"",
+		},
+		{
+			name: "stable",
+			args: args{
+				version: "emacs-27.2",
+			},
+			want: "27.2",
+		},
+		{
+			name: "stable with letter",
+			args: args{
+				version: "emacs-23.3b",
+			},
+			want: "23.3b",
+		},
+		{
+			name: "future stable",
+			args: args{
+				version: "emacs-239.33",
+			},
+			want: "239.33",
+		},
+		{
+			name: "future stable with letter",
+			args: args{
+				version: "emacs-239.33c",
+			},
+			want: "239.33c",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := GitRefToStableVersion(tt.args.version)
+
+			assert.Equal(t, tt.want, got)
+
+			if tt.wantErr != "" {
+				assert.EqualError(t, err, tt.wantErr)
+			} else {
+				assert.NoError(t, err)
+			}
+		})
+	}
+}