Feature/pin packer dependencies

contribute/README.md

@@ -37,3 +37,22 @@ These are the folders used by this docker image, they will be auto generated whe
 `contribute/doom-nvim-contrib/` - Git worktree for doom-nvim contributions
 `contribute/local-share-nvim/` - Stores the data from `~/.local/share/nvim/` 
 `contribute/workspace/` - Directory to store test files and project that you want to test your changes upon
+
+## Pinned Dependencies `./update_dependencies.sh`
+
+This script parses the `lua/doom/modules/init.lua` file and pins each plugin to the latest commit in the default branch.  
+We should update these dependencies with each release of doom-nvim, and test everything working together to ensure a stable experience for users.
+Pinned/frozen dependencies can be disabled using the `freeze_dependencies` configuration option in `doom_config.lua`.
+
+### How to use
+
+Run the following command in the root of the neovim folder.
+```bash
+cd contribute && ./update_dependencies.sh`
+```
+
+### Issues
+- The `commit = pin_commit(...)` line must be immediately after the package name
+- It does not work if the dependency also has the `branch = '...'` option.  These will have to be updated manually.
+- It does not work if there is custom logic for determining pinned commits (such as depending on neovim version).  These will have to be updated manually.
+- Github API ratelimits requests, you can specify a GITHUB_API_KEY environment variable (docs)[https://docs.github.com/en/developers/apps/building-oauth-apps], or you can use a VPN to change IP addresses.

contribute/update_dependencies.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+
+# This script updates pinned dependencies in ../lua/doom/modules/init.lua
+# It uses grep to find instances of packer.use, uses the repository url to fetch the latest commit sha, and modifies the values
+# Dependencies
+# perl -- used for Regexing the repository <account>/<repo_name> with capture groups to extract inner text
+# grep -- Used for regexing the use({}) block with line numbers
+# 
+
+index=0
+repo_regex='"([^"]+)"'
+pin_commit_regex='commit = pin_commit[(][^()]*[)]'
+
+repo=''
+latest_commit=''
+
+while read -r line; do
+  if [[ $index -eq 1 ]]; then
+    # Get the repository name as `<username>/reponame`
+    if [[ $line =~ $repo_regex ]]; then # Regex $line against $repo_regex
+      repo="${BASH_REMATCH[1]}" # Get first capture group
+      echo ""
+      echo "Updating $repo:"
+
+      # Sometimes the github api requests will fail, in which case we need to re-try after a delay.
+      while [ -z "$latest_commit" ]; do
+        # Get the commit sha from github, use GITHUB_API_KEY if provided 
+        # GITHUB_API_KEY in this instance is an OAuth2 token
+        # https://docs.github.com/en/developers/apps/building-oauth-apps
+        if [ -z GITHUB_API_KEY ]; then
+          api_result=`curl -s \
+            -H "Accept: application/vnd.github.v3+json" \
+            https://api.github.com/repos/$repo/commits?per_page=1`
+        else
+          api_result=`curl -s \
+            -H "Accept: application/vnd.github.v3+json" \
+            -H "Authentication: token $GITHUB_API_KEY" \
+            https://api.github.com/repos/$repo/commits?per_page=1`
+        fi
+
+        # If there's an error, log it and wait 30 seconds
+        is_array=`echo $api_result | jq -r 'if type=="array" then "yes" else "no" end'`
+        if [ "$is_array" = "no" ]; then
+          echo "- Github API Error: $( echo "$api_result" | jq -r .message )"
+          echo "- Waiting 30 seconds before trying again..."
+          sleep 30
+        else
+          latest_commit=`echo $api_result | jq -r .[0].sha`
+        fi
+
+      done
+    else
+      echo " - ERROR: No repo name for $line :("
+    fi
+  fi
+
+  # Update the pinned commit if possible
+  if [[ $index -eq 2 ]]; then
+    if [ ! -z "$repo" ] && [ ! -z "$latest_commit" ] && [[ $line =~ $pin_commit_regex ]]; then 
+      line_number=`echo $line | awk -F "-" '{print $1}'`
+      sed -r -i -- "${line_number}s/commit = pin_commit[(][^()]*[)]/commit = pin_commit('${latest_commit}')/" "../lua/doom/modules/init.lua"
+      echo " - Updated to $latest_commit"
+    else
+      echo " - ERROR: Did not update $repo because \`commit = pin_commit('...')\` was not immediately after the repo name or there is custom logic for determining the pinned commit.  Please update this entry manually."
+    fi
+  fi
+
+  let index+=1
+  if [[ $line == '--' ]]; then
+    sleep 5
+    index=0
+    repo=''
+    latest_commit=''
+  fi
+done < <(grep -n "use\(\{" -A 2 -E ../lua/doom/modules/init.lua)
+
+

doom_config.lua

@@ -14,6 +14,10 @@ M.source = debug.getinfo(1, "S").source:sub(2)
 
 M.config = {
   doom = {
+    -- Pins plugins to a commit sha to prevent breaking changes
+    -- @default = true
+    freeze_dependencies = true,
+
     -- Autosave
     -- false : Disable autosave
     -- true  : Enable autosave