chore(release): 0.6.20

Previously we just copies the whole "src" directory from the workdir, it
turns out it has some binary files after a successful build, which
caused Apple's notarization process to fail.

As we actually only care about the *.c and *.h files from the "src"
directory, let's explicitly only copy those files.

CHANGELOG.md

@@ -2,6 +2,39 @@
 
 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.20](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.19...v0.6.20) (2021-10-23)
+
+
+### Bug Fixes
+
+* **notarization:** explicitly only copy *.c and *.h C source files ([591c39e](https://github.com/jimeh/build-emacs-for-macos/commit/591c39e629c9556adcf296cd5c15dd0b17c4d986))
+
+### [0.6.19](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.18...v0.6.19) (2021-10-23)
+
+
+### Bug Fixes
+
+* **patch:** resolve emacs-29 symlink patches to their real URL ([bcbd017](https://github.com/jimeh/build-emacs-for-macos/commit/bcbd01778d416b99205c51f348a543489889f66d))
+
+### [0.6.18](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.17...v0.6.18) (2021-10-23)
+
+
+### Features
+
+* **docs:** embed C source files and set source-directory accordingly ([67b8c5f](https://github.com/jimeh/build-emacs-for-macos/commit/67b8c5f3974e178e31519846d46af82d9770ad6e))
+
+
+### Bug Fixes
+
+* **patches:** correctly use emacs 28.x and 29.x patches ([4dad581](https://github.com/jimeh/build-emacs-for-macos/commit/4dad5812fa2b67adc7262a778829013995a904bc))
+
+### [0.6.17](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.16...v0.6.17) (2021-10-10)
+
+
+### Features
+
+* **release:** tweak GitHub release description ([a956dc1](https://github.com/jimeh/build-emacs-for-macos/commit/a956dc1b42b2648e2663f5b48c72d7428fe75f19))
+
 ### [0.6.16](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.15...v0.6.16) (2021-10-10)
 
 

build-emacs-for-macos

@@ -107,6 +107,7 @@ class Build
     handle_native_lisp(app)
     add_cli_helper(app)
 
+    CSourcesEmbedder.new(app, @source_dir).embed
     LibEmbedder.new(app, brew_dir, extra_libs, options[:relink_eln]).embed
     GccLibEmbedder.new(app, gcc_info).embed if options[:native_comp]
 
@@ -640,8 +641,10 @@ class Build
         'emacs-26'
       when /^emacs-27.*/
         'emacs-27'
-      else
+      when /^emacs-28.*/
         'emacs-28'
+      else
+        'emacs-29'
       end
     end
   end
@@ -649,14 +652,14 @@ class Build
   def patches(opts = {})
     p = []
 
-    if %w[emacs-26 emacs-27 emacs-28].include?(effective_version)
+    if %w[emacs-26 emacs-27 emacs-28 emacs-29].include?(effective_version)
       p << {
         url: 'https://github.com/d12frosted/homebrew-emacs-plus/raw/master/' \
              "patches/#{effective_version}/fix-window-role.patch"
       }
     end
 
-    if %w[emacs-27 emacs-28].include?(effective_version)
+    if %w[emacs-27 emacs-28 emacs-29].include?(effective_version)
       p << {
         url: 'https://github.com/d12frosted/homebrew-emacs-plus/raw/master/' \
              "patches/#{effective_version}/system-appearance.patch"
@@ -714,7 +717,14 @@ class Build
       info "Downloading patch: #{patch[:url]}"
       run_cmd('curl', '-L#', patch[:url], '-o', patch_file)
 
-      apply_patch({ file: patch_file }, target)
+      real_patch_url = detect_github_symlink_patch(patch[:url], patch_file)
+      if real_patch_url
+        FileUtils.rm(patch_file)
+        apply_patch({ url: real_patch_url }, target)
+      else
+        apply_patch({ file: patch_file }, target)
+      end
+
     elsif patch[:replace]
       err 'Patch replace input error' unless patch[:replace].size == 3
 
@@ -732,6 +742,30 @@ class Build
       f.close
     end
   end
+
+  # When downloading raw files from GitHub, if the target file is a symlink, it
+  # will return the actual target path of the symlink instead of the content of
+  # the target file. Hence we have to check if the patch file we have downloaded
+  # contains one and only one line, and if so, assume it's a symlink.
+  def detect_github_symlink_patch(original_url, patch_file)
+    lines = []
+
+    # read first two lines
+    File.open(patch_file) do |f|
+      lines << f.gets
+      lines << f.gets
+    end
+
+    # if the file contains more than one line of text, it's not a symlink.
+    return unless lines[1].nil?
+
+    symlink_target = lines[0].strip
+    # Assume patch file content is something along the lines of
+    # "../emacs-28/fix-window-role.patch", hence we resolve it relative to the
+    # original url.
+    info "patch is symlink to #{symlink_target}"
+    URI.join(original_url, symlink_target).to_s
+  end
 end
 
 class AbstractEmbedder
@@ -756,6 +790,46 @@ class AbstractEmbedder
   def lib_dir
     File.join(invocation_dir, 'lib')
   end
+
+  def resources_dir
+    File.join(app, 'Contents', 'Resources')
+  end
+end
+
+class CSourcesEmbedder < AbstractEmbedder
+  PATH_PATCH = '(setq source-directory (expand-file-name ".."))'
+
+  attr_reader :source_dir
+
+  def initialize(app, source_dir)
+    super(app)
+
+    @source_dir = source_dir
+  end
+
+  def embed
+    info 'Embedding C source files into Emacs.app for documentation purposes'
+
+    src_dir = File.join(source_dir, 'src')
+    Dir[File.join(src_dir, '**', '*.{c,h}')].each do |f|
+      rel = f[src_dir.size + 1..-1]
+      target = File.join(resources_dir, 'src', rel)
+      FileUtils.mkdir_p(File.dirname(target))
+      FileUtils.cp(f, target)
+    end
+
+    return if File.read(subdirs_el_file).include?(PATH_PATCH)
+
+    File.open(subdirs_el_file, 'a') do |f|
+      f.puts("\n#{PATH_PATCH}")
+    end
+  end
+
+  private
+
+  def subdirs_el_file
+    @subdirs_el_file ||= File.join(resources_dir, 'lisp', 'subdirs.el')
+  end
 end
 
 class LibEmbedder < AbstractEmbedder

pkg/release/release_body.go

@@ -22,11 +22,9 @@ var bodyTpl = template.Must(template.New("body").Funcs(tplFuncs).Parse(`
 {{ with .SourceURL -}}
 - Source: {{ . }}
 {{- end }}
-{{- if and .CommitSHA .CommitURL }}
-- Commit: [{{ $t }}{{ .CommitSHA }}{{ $t }}]
-  {{- if .CommitURL }}({{ .CommitURL }}){{ end }}
-{{- else if and .CommitSHA }}
-- Commit: {{ $t }}{{ .CommitSHA }}{{ $t }}
+{{- if .CommitURL }}
+- Commit: {{ .CommitURL }}
+  {{- if .CommitSHA }} ({{ $t }}{{ .CommitSHA }}{{ $t }}){{ end }}
 {{- end }}
 {{- with .TarballURL }}
 - Tarball: {{ . }}