Merge pull request #4 from peter-evans/container-action-update

Update for Actions v2

.circleci/config.yml

@@ -1,70 +0,0 @@
-version: 2.1
-executors:
-  docker-executor:
-    environment:
-      IMAGE_NAME: peterevans/dockerhub-description
-    docker:
-      - image: circleci/buildpack-deps:stretch
-jobs:
-  build:
-    executor: docker-executor
-    steps:
-      - checkout
-      - setup_remote_docker:
-          docker_layer_caching: true
-      - run:
-          name: Build Docker image
-          command: |
-            docker build -t $IMAGE_NAME:latest . --label "org.opencontainers.image.version=${CIRCLE_TAG/v/''}"
-      - run:
-          name: Cache Docker image
-          command: docker save -o image.tar $IMAGE_NAME
-      - persist_to_workspace:
-          root: .
-          paths:
-            - ./image.tar
-  publish-tag:
-    executor: docker-executor
-    steps:
-      - attach_workspace:
-          at: /tmp/workspace
-      - setup_remote_docker
-      - run:
-          name: Load cached Docker image
-          command: docker load -i /tmp/workspace/image.tar
-      - run:
-          name: Publish Docker Image to Docker Hub
-          command: |
-            echo "$DOCKERHUB_PASSWORD" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin
-            IMAGE_TAG=${CIRCLE_TAG/v/''}
-            docker tag $IMAGE_NAME:latest $IMAGE_NAME:$IMAGE_TAG
-            docker push $IMAGE_NAME:latest
-            docker push $IMAGE_NAME:$IMAGE_TAG
-            # If the minor version can be extracted then tag and push
-            MINOR_VERSION=$(echo $CIRCLE_TAG | sed -n "s/^v\([0-9]*.[0-9]*\).[0-9]*$/\1/p")
-            if [[ ${#MINOR_VERSION} -gt 0 ]]; then
-              docker tag $IMAGE_NAME:latest $IMAGE_NAME:$MINOR_VERSION
-              docker push $IMAGE_NAME:$MINOR_VERSION
-            fi
-workflows:
-  version: 2
-  build:
-    jobs:
-      - build
-  build-and-publish-tags:
-    jobs:
-      - build:
-          filters:
-            tags:
-              only: /^v.*/
-            branches:
-              ignore: /.*/
-      - publish-tag:
-          context: org-global
-          requires:
-            - build
-          filters:
-            tags:
-              only: /^v.*/
-            branches:
-              ignore: /.*/

.github/workflows/push.yml

@@ -7,7 +7,7 @@ jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v1
     - name: Docker Hub Description
       uses: ./
       env:

README.md

@@ -10,7 +10,7 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
 
 ```yml
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v1.0.1
+      uses: peter-evans/dockerhub-description@v2.0.0
       env:
         DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
         DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -19,9 +19,9 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
 
 #### Required environment variables
 
-- `DOCKERHUB_USERNAME` - Docker Hub username
-- `DOCKERHUB_PASSWORD` - Docker Hub password
-- `DOCKERHUB_REPOSITORY` - The Docker Hub repository to update in the format `<namespace>/<name>`
+- `DOCKERHUB_USERNAME` - Docker Hub username. If updating a Docker Hub repository belonging to an organization, this user must have `Admin` permissions for the repository.
+- `DOCKERHUB_PASSWORD` - Docker Hub password.
+- `DOCKERHUB_REPOSITORY` - The Docker Hub repository to update in the format `<namespace>/<name>`.
 
 Note that `DOCKERHUB_REPOSITORY` may also be passed as a secret if considered sensitive.
 
@@ -32,7 +32,7 @@ If this is not the case, the path can be overridden with an environment variable
 
 ```yml
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v1.0.1
+      uses: peter-evans/dockerhub-description@v2.0.0
       env:
         DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
         DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -55,7 +55,7 @@ jobs:
     steps:
     - uses: actions/checkout@master
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v1.0.1
+      uses: peter-evans/dockerhub-description@v2.0.0
       env:
         DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
         DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -72,7 +72,7 @@ jobs:
     steps:
     - uses: actions/checkout@master
     - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v1.0.1
+      uses: peter-evans/dockerhub-description@v2.0.0
       env:
         DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
         DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
@@ -90,7 +90,7 @@ docker run -v $PWD:/workspace \
   -e DOCKERHUB_PASSWORD='xxxxx' \
   -e DOCKERHUB_REPOSITORY='user1/my-docker-image' \
   -e README_FILEPATH='/workspace/README.md' \
-  peterevans/dockerhub-description:1.0.1
+  peterevans/dockerhub-description:2.0.0
 ```
 
 ## License

action.yml

@@ -0,0 +1,9 @@
+name: 'Docker Hub Description'
+author: 'Peter Evans'
+description: 'An action to update a Docker Hub repository description from README.md'
+runs:
+  using: 'docker'
+  image: 'docker://peterevans/dockerhub-description:2.1.0'
+branding:
+  icon: 'upload'  
+  color: 'blue'