Merge pull request #3 from iamamutt/main

Move flit to directory

Author: drewyangdev

.github/actions/bake-cookies/action.yml

@@ -10,7 +10,7 @@ inputs:
   build_branch:
     description: "Branch name that holds the generated content"
     required: false
-    default: build
+    default: build_test
 
   folder:
     description: "Subdirectory for a specific template"
@@ -56,7 +56,7 @@ runs:
     - name: Upload Artifact Content
       uses: actions/upload-artifact@v3
       with:
-        name: cookiecutter_content_${{ inputs.new_tag }}
+        name: ${{ inputs.folder }}_${{ inputs.new_tag }}
         path: .build/${{ inputs.folder }}
 
     - name: Create 'build' Branch
@@ -93,7 +93,7 @@ runs:
     - name: Downloading Artifact Content
       uses: actions/download-artifact@v3
       with:
-        name: cookiecutter_content_${{ inputs.new_tag }}
+        name: ${{ inputs.folder }}_${{ inputs.new_tag }}
         path: ${{ inputs.build_branch }}/${{ inputs.folder }}
 
     - name: Copying Built Content to Branch
@@ -114,6 +114,11 @@ runs:
       working-directory: ${{ inputs.build_branch }}
       shell: bash
 
+outputs:
+  artifact:
+    description: "Name of the uploaded artifact"
+    value: ${{ inputs.folder }}_${{ inputs.new_tag }}
+
 branding:
   icon: "aperture"
   color: "blue"

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: run-ci-jobs
 
 on:
   push:
-    branches: ["main", "flit"]
+    branches: ["main"]
 
 jobs:
   get_tag:
@@ -19,97 +19,115 @@ jobs:
         id: tag_version
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          release_branches: main,flit
+          release_branches: main
           create_annotated_tag: false
           fetch_all_tags: true
 
-  generate_flit_content:
+  generate_workflow_content:
     runs-on: ubuntu-latest
     needs: get_tag
     if: |
       always() &&
       (needs.get_tag.result == 'success') &&
-      (github.ref_name == 'flit') &&
+      (github.ref_name == 'main') &&
       (github.ref_type == 'branch')
     steps:
       - name: Checkout Repository for Local Action
         uses: actions/checkout@v3
 
-      - name: Generate Content from 'flit' Template
+      - name: Generate Content from 'workflow' Template
         id: bake-cookies
         uses: ./.github/actions/bake-cookies
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          folder: o-science-institute_w-neuro-lab
-          cookiecutter_pkg: git+https://github.com/cookiecutter/cookiecutter
-          cookiecutter_args: -f --no-input
+          folder: workflow_name
+          cookiecutter_args: -f --no-input --directory workflow
           new_tag: ${{ needs.get_tag.outputs.new_tag }}
+    outputs:
+      artifact: ${{ steps.bake-cookies.outputs.artifact }}
 
-  generate_workflow_content:
+  generate_flit_content:
     runs-on: ubuntu-latest
-    needs: [get_tag]
+    needs: [get_tag, generate_workflow_content]
     if: |
       always() &&
       (needs.get_tag.result == 'success') &&
+      (needs.generate_workflow_content.result == 'success') &&
       (github.ref_name == 'main') &&
       (github.ref_type == 'branch')
     steps:
       - name: Checkout Repository for Local Action
         uses: actions/checkout@v3
 
-      - name: Generate Content from 'workflow' Template
+      - name: Generate Content from 'flit' Template
         id: bake-cookies
         uses: ./.github/actions/bake-cookies
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          folder: workflow_name
-          cookiecutter_args: -f --no-input --directory workflow
+          folder: o-science-institute_w-neuro-lab
+          cookiecutter_pkg: git+https://github.com/cookiecutter/cookiecutter
+          cookiecutter_args: -f --no-input --directory flit
           new_tag: ${{ needs.get_tag.outputs.new_tag }}
+    outputs:
+      artifact: ${{ steps.bake-cookies.outputs.artifact }}
 
   generate_element_content:
     runs-on: ubuntu-latest
-    needs: [get_tag, generate_workflow_content]
+    needs: [get_tag, generate_flit_content]
     if: |
       always() &&
       (needs.get_tag.result == 'success') &&
-      (needs.generate_workflow_content.result == 'success') &&
+      (needs.generate_flit_content.result == 'success') &&
       (github.ref_name == 'main') &&
       (github.ref_type == 'branch')
     steps:
       - run: echo "Element template not yet available"
-      # - name: Checkout Repository for Local Action
-      #   uses: actions/checkout@v3
+    #   - name: Checkout Repository for Local Action
+    #     uses: actions/checkout@v3
 
-      # - name: Generate Content from 'element' Template
-      #   id: bake-cookies
-      #   uses: ./.github/actions/bake-cookies
-      #   with:
-      #     github_token: ${{ secrets.GITHUB_TOKEN }}
-      #     folder: element_name
-      #     cookiecutter_args: -f --no-input --directory element
-      #     new_tag: ${{ needs.get_tag.outputs.new_tag }}
+    #   - name: Generate Content from 'element' Template
+    #     id: bake-cookies
+    #     uses: ./.github/actions/bake-cookies
+    #     with:
+    #       github_token: ${{ secrets.GITHUB_TOKEN }}
+    #       folder: element_name
+    #       cookiecutter_args: -f --no-input --directory element
+    #       new_tag: ${{ needs.get_tag.outputs.new_tag }}
+    # outputs:
+    #   artifact: ${{ steps.bake-cookies.outputs.artifact }}
 
   make_release:
     runs-on: ubuntu-latest
-    needs: [get_tag, generate_flit_content, generate_element_content]
+    needs:
+      [
+        get_tag,
+        generate_flit_content,
+        generate_workflow_content,
+        generate_element_content,
+      ]
     if: |
       always() &&
       (needs.get_tag.result == 'success') &&
-      (
-        needs.generate_flit_content.result == 'success' ||
-        needs.generate_element_content.result == 'success'
-      )
+      (needs.generate_element_content.result == 'success')
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Downloading Artifact Content
+      - name: Downloading 'flit' Artifact Content
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ needs.generate_flit_content.outputs.artifact }}
+          path: ${{ needs.generate_flit_content.outputs.artifact }}
+
+      - name: Downloading 'workflow' Artifact Content
         uses: actions/download-artifact@v3
         with:
-          name: cookiecutter_content_${{ needs.get_tag.outputs.new_tag }}
-          path: cookiecutter_content
+          name: ${{ needs.generate_workflow_content.outputs.artifact }}
+          path: ${{ needs.generate_workflow_content.outputs.artifact }}
 
-      - run: tar -zcf cookiecutter_content_${{ github.ref_name }}_${{ needs.get_tag.outputs.new_tag }}.tar.gz cookiecutter_content
+      - run: |
+          tar -zcf ${{ needs.generate_flit_content.outputs.artifact }}.tar.gz ${{ needs.generate_flit_content.outputs.artifact }}
+          tar -zcf ${{ needs.generate_workflow_content.outputs.artifact }}.tar.gz ${{ needs.generate_workflow_content.outputs.artifact }}
 
       - name: Create a Release
         uses: ncipollo/release-action@v1
@@ -120,4 +138,6 @@ jobs:
           body: ${{ needs.get_tag.outputs.changelog }}
           allowUpdates: true
           generateReleaseNotes: true
-          artifacts: "cookiecutter_content_${{ github.ref_name }}_${{ needs.get_tag.outputs.new_tag }}.tar.gz"
+          artifacts: |
+            ${{ needs.generate_flit_content.outputs.artifact }}.tar.gz
+            ${{ needs.generate_workflow_content.outputs.artifact }}.tar.gz

.gitignore

@@ -129,5 +129,7 @@ dmypy.json
 .pyre/
 
 .DS_Store
-*.code-workspace
-.build/
+/.build/
+/*.code-workspace
+/o-science-institute_w-neuro-lab
+/build/

README.md

@@ -18,7 +18,7 @@ pip install cookiecutter
 
 **Refer template from github repo or local directory**
 ```
-cookiecutter [email protected]:Yambottle/dj-cookiecutter.git --directory workflow
+cookiecutter [email protected]:datajoint-company/dj-cookiecutter.git --directory workflow
 # set value to each variable, or skip to use default value
 # a python project will be generated at ~/Project/project_name/
 
@@ -27,20 +27,22 @@ cookiecutter [email protected]:Yambottle/dj-cookiecutter.git --directory workflow
 cookiecutter ./existing_cookiecutter --directory workflow
 
 # generate a project to a specific directory: ./Projects
-cookiecutter [email protected]:Yambottle/dj-cookiecutter.git --directory workflow -o ./Project
+cookiecutter [email protected]:datajoint-company/dj-cookiecutter.git --directory workflow -o ./Project
 # files will be in ./Projects/project_name
 
 # this repo supports multiple cookiecutter templates
-cookiecutter [email protected]:Yambottle/dj-cookiecutter.git --directory element
+cookiecutter [email protected]:datajoint-company/dj-cookiecutter.git --directory element
 
 # if you have already started working on your project and there are existing files
-cookiecutter [email protected]:Yambottle/dj-cookiecutter.git --directory workflow --overwrite-if-exists
+cookiecutter [email protected]:datajoint-company/dj-cookiecutter.git --directory workflow --overwrite-if-exists
 # or
-cookiecutter [email protected]:Yambottle/dj-cookiecutter.git --directory workflow --skip-if-file-exists
+cookiecutter [email protected]:datajoint-company/dj-cookiecutter.git --directory workflow --skip-if-file-exists
 ```
 
 > Note: cookiecutter will cache/clone this specified template repo to your user directory's ~/.cookiecutters
 
+> Note: the [`flit`](flit/README.md) template requires _cookiecutter>=2.0.0_
+
 **context of cookiecutter.json**
 ```
 {
@@ -59,4 +61,4 @@ If you want to know more details, read this [page](https://cookiecutter.readthed
 
 ---
 ## License
-© Datajoint, 2022. Licensed under an MIT license.
+© Datajoint, 2022. Licensed under an MIT license.

flit/.gitignore

@@ -0,0 +1,9 @@
+__pycache__
+.DS_Store
+.nox
+*.egg-info
+.ipynb_checkpoints
+/*.code-workspace
+build/
+.build/
+/o-science-institute_w-neuro-lab

flit/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Joseph Burling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.