Merge pull request #1185 from ipfs/feat/renaming-go-ipfs

refactor: rename `go-ipfs` to `kubo`
See ipfs/kubo#8959

Author: lidel

.github/actions/latest-ipfs-tag/action.yml

@@ -0,0 +1,7 @@
+name: 'Find latest Kubo tag'
+outputs:
+  latest_tag:
+    description: "latest Kubo tag name"
+runs:
+  using: 'docker'
+  image: 'Dockerfile'

.github/actions/latest-ipfs-tag/Dockerfile renamed to .github/actions/latest-kubo-tag/Dockerfile

@@ -2,16 +2,16 @@
 set -eu
 
 # extract tag name from latest stable release
-REPO="ipfs/go-ipfs"
-LATEST_IPFS_TAG=$(curl -H "Accept: application/vnd.github.v3+json" "https://api.github.com/repos/${REPO}/releases/latest" | jq --raw-output ".tag_name")
+REPO="ipfs/kubo"
+LATEST_IPFS_TAG=$(curl -L -H "Accept: application/vnd.github.v3+json" "https://api.github.com/repos/${REPO}/releases/latest" | jq --raw-output ".tag_name")
 
 # extract IPFS release
 cd /tmp
 git clone "https://github.com/$REPO.git"
-cd go-ipfs
+cd kubo
 
 # confirm tag is valid
 git describe --tags "${LATEST_IPFS_TAG}"
 
-echo "The latest IPFS tag is ${LATEST_IPFS_TAG}"
+echo "The latest Kubo tag is ${LATEST_IPFS_TAG}"
 echo "::set-output name=latest_tag::${LATEST_IPFS_TAG}"

.github/actions/latest-kubo-tag/action.yml

@@ -1,7 +1,7 @@
 name: 'Update when a new tag or a new release is available'
 inputs:
   latest_ipfs_tag:
-      description: "latest go ipfs tag"
+      description: "latest Kubo tag"
       required: true
 outputs:
   updated_branch:

.github/actions/latest-ipfs-tag/entrypoint.sh renamed to .github/actions/latest-kubo-tag/entrypoint.sh

@@ -4,40 +4,40 @@ set -eu
 BRANCH=bump-documentation-to-latest-versions
 LATEST_IPFS_TAG=$INPUT_LATEST_IPFS_TAG
 
-echo "The latest IPFS tag is ${LATEST_IPFS_TAG}"
+echo "The latest Kubo tag is ${LATEST_IPFS_TAG}"
 
 ROOT=`pwd`
 git checkout -b ${BRANCH}
-API_FILE=`pwd`/docs/reference/http/api.md
+API_FILE="$(pwd)/docs/reference/kubo/rpc.md"
 
 
 # Update http api docs and cli docs
 
 cd tools/http-api-docs
 
-# extract go-ipfs release tag used in http-api-docs from go.mod in this repo
-CURRENT_IPFS_TAG=`grep 'github.com/ipfs/go-ipfs ' ./go.mod | awk '{print $2}'`
-echo "The currently used go-ipfs tag in http-api-docs is ${CURRENT_IPFS_TAG}"
+# extract kubo release tag used in http-api-docs from go.mod in this repo
+CURRENT_IPFS_TAG=$(grep 'github.com/ipfs/kubo ' ./go.mod | awk '{print $2}')
+echo "The currently used Kubo tag in http-api-docs is ${CURRENT_IPFS_TAG}"
 
-# make the upgrade, if newer go-ipfs tags exist
+# make the upgrade, if newer Kubo tags exist
 if [ "$CURRENT_IPFS_TAG" = "$LATEST_IPFS_TAG" ]; then
-    echo "http-api-docs already uses the latest go-ipfs tag."
+    echo "http-api-docs already uses the latest Kubo tag."
 else
      # update http-api-docs
-     sed "s/^\s*github.com\/ipfs\/go-ipfs\s\+$CURRENT_IPFS_TAG\s*$/	github.com\/ipfs\/go-ipfs $LATEST_IPFS_TAG/" go.mod > go.mod2
+     sed "s/^\s*github.com\/ipfs\/kubo\s\+$CURRENT_IPFS_TAG\s*$/	github.com\/ipfs\/kubo $LATEST_IPFS_TAG/" go.mod > go.mod2
      mv go.mod2 go.mod
      go mod tidy
      make
      http-api-docs > "$API_FILE"
 
      # update cli docs
      cd "$ROOT" # go back to root of ipfs-docs repo
-     git clone https://github.com/ipfs/go-ipfs.git
-     cd go-ipfs
+     git clone https://github.com/ipfs/kubo.git
+     cd kubo
      git fetch --all --tags
      git checkout "tags/$LATEST_IPFS_TAG"
      go install ./cmd/ipfs
-     cd "$ROOT/docs/reference"
+     cd "$ROOT/docs/reference/kubo"
      ./generate-cli-docs.sh
 fi
 
@@ -64,7 +64,7 @@ update_version() {
 cd "${ROOT}"
 update_version ipfs/ipfs-update current-ipfs-updater-version
 update_version ipfs-cluster/ipfs-cluster current-ipfs-cluster-version
-update_version ipfs/go-ipfs current-ipfs-version
+update_version ipfs/kubo current-ipfs-version
 
 
 # Push on change

.github/actions/update-with-latest-versions/action.yml

@@ -11,9 +11,9 @@ jobs:
     steps:
       - name: Checkout ipfs-docs
         uses: actions/checkout@v2
-      - name: Find latest go-ipfs tag
+      - name: Find latest kubo tag
         id: latest_ipfs
-        uses: ./.github/actions/latest-ipfs-tag
+        uses: ./.github/actions/latest-kubo-tag
       - name: Update docs
         id: update
         uses: ./.github/actions/update-with-latest-versions
@@ -26,7 +26,7 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           source_branch: ${{ steps.update.outputs.updated_branch }}
           destination_branch: "main"
-          pr_title: "Update documentation ${{ steps.latest_ipfs.outputs.latest_tag }}"
-          pr_body: "Release Notes: https://github.com/ipfs/go-ipfs/releases/${{ steps.latest_ipfs.outputs.latest_tag }}"
+          pr_title: "Update release version numbers"
+          pr_body: "This PR was opened from update-on-new-ipfs-tag.yml workflow."
           pr_label: "needs/triage,P0"
 

.github/actions/update-with-latest-versions/entrypoint.sh

@@ -64,9 +64,9 @@ Write everything in using the [GitHub Flavored Markdown](https://github.github.c
 
 ### Project specific titles
 
-When referring to projects by name, use proper noun capitalization: Go-IPFS and JS-IPFS.
+When referring to projects by name, use proper noun capitalization: Kubo (GO-IPFS) and JS-IPFS.
 
-Cases inside code blocks refer to commands and are not capitalized: `go-ipfs` or `js-ipfs`.
+Cases inside code blocks refer to commands and are not capitalized: `kubo` (`go-ipfs`) or `js-ipfs`.
 
 ### Style and tone
 

.github/workflows/update-on-new-ipfs-tag.yml

@@ -263,10 +263,11 @@ module.exports = {
             title: 'API & CLI',
             path: '/reference/',
             children: [
-              '/reference/go/api',
+              '/reference/http/gateway',
               '/reference/js/api',
-              '/reference/http/api',
-              '/reference/cli'
+              '/reference/go/api',
+              '/reference/kubo/cli',
+              '/reference/kubo/rpc'
             ]
           },
           {

CONTRIBUTING.md

@@ -51,7 +51,10 @@
 /recent-releases/go-ipfs-0-7/install/ /install/recent-releases
 /recent-releases/go-ipfs-0-7/update-procedure/ /install/recent-releases
 /reference/api/ /reference
-/reference/api/cli/ /reference/cli
+/reference/api/cli/ /reference/kubo/cli
+/reference/cli/ /reference/kubo/cli
+/reference/kubo/ /reference
+/reference/http/ /reference/http/api
 /reference/api/http/ /reference/http/api
 /reference/go/overview/ /reference/go/api
 /reference/js/overview/ /reference/js/api