From a913a745332be952d5e98caa069f42d6244b0385 Mon Sep 17 00:00:00 2001 From: Michael Dockter Date: Thu, 28 Dec 2023 08:30:58 -0500 Subject: [PATCH] 69.dockter.1 (#70) * #69 Migrate repository * #69 Migrate repository --- .dockerignore | 2 - .github/CODEOWNERS | 2 +- .github/ISSUE_TEMPLATE/bug_report.md | 38 -------------- .../ISSUE_TEMPLATE/documentation_request.md | 26 ---------- .github/ISSUE_TEMPLATE/feature_request.md | 17 ------ ...-dependabot-request-to-project-t-comm.yaml | 27 ---------- .../add-issue-to-project-t-comm.yaml | 24 --------- ...aml => add-label-customer-submission.yaml} | 12 ++--- ...riage-label.yaml => add-label-triage.yaml} | 12 ++--- .../add-to-project-garage-dependabot.yaml | 21 ++++++++ .github/workflows/add-to-project-garage.yaml | 16 ++++++ .../dependabot-approve-and-merge.yaml | 3 -- .github/workflows/docker-build-container.yaml | 2 - .../docker-push-containers-to-dockerhub.yaml | 2 - .github/workflows/move-pr-to-done.yaml | 3 -- CONTRIBUTING.md | 2 +- Makefile | 4 +- PULL_REQUEST_TEMPLATE.md | 13 ----- README.md | 52 ++++++++++++------- 19 files changed, 80 insertions(+), 198 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/documentation_request.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/workflows/add-dependabot-request-to-project-t-comm.yaml delete mode 100644 .github/workflows/add-issue-to-project-t-comm.yaml rename .github/workflows/{identify-customer.yaml => add-label-customer-submission.yaml} (68%) rename .github/workflows/{add-triage-label.yaml => add-label-triage.yaml} (51%) create mode 100644 .github/workflows/add-to-project-garage-dependabot.yaml create mode 100644 .github/workflows/add-to-project-garage.yaml delete mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/.dockerignore b/.dockerignore index ccf5896..7f0585c 100644 --- a/.dockerignore +++ b/.dockerignore @@ -10,6 +10,4 @@ CONTRIBUTING.md docker-compose.test.yml LICENSE Makefile -PULL_REQUEST_TEMPLATE.md README.md -requirements.txt diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 3df4113..04b7aa2 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,3 +1,3 @@ # Default code owner -* @Senzing/senzing-community +* @senzing-garage/senzing-mechanics diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d3a80d7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - -- OS: [e.g. iOS] -- Browser [e.g. chrome, safari] -- Version [e.g. 22] - -**Smartphone (please complete the following information):** - -- Device: [e.g. iPhone6] -- OS: [e.g. iOS8.1] -- Browser [e.g. stock browser, safari] -- Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation_request.md b/.github/ISSUE_TEMPLATE/documentation_request.md deleted file mode 100644 index c18a3fa..0000000 --- a/.github/ISSUE_TEMPLATE/documentation_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Documentation request -about: Identify an area for improvement in documentation - ---- - -**What is the URL of the documentation?** - -- **Example:** https://github.com/Senzing/template-docker#external-database - - *Note:* This URL includes the web page and the section of the documentation. - -**What can be improved?** - -A clear and concise description of what can be improved. -Examples: - -- "I don't understand where the ${XYZ} variable is set." -- "There seems to be a step missing between 'X' and 'Z'. I don't know how to get to 'Z'." -- "When I run `command sub-command ...` I get the following error:" -- "I don't know what is meant by 'gerble barb gazoink` in the instructions". - -**Additional context** - -Add any other context or screenshots to help describe the documentation improvement. -If you think the documentation improvement is operating system specific, -please indicate which operating system is being used. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 066b2d9..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/add-dependabot-request-to-project-t-comm.yaml b/.github/workflows/add-dependabot-request-to-project-t-comm.yaml deleted file mode 100644 index 5d9cbcb..0000000 --- a/.github/workflows/add-dependabot-request-to-project-t-comm.yaml +++ /dev/null @@ -1,27 +0,0 @@ -# Based on -# - https://github.com/srggrs/assign-one-project-github-action - -name: add-dependabot-request-to-project-t-comm.yaml - -on: - pull_request: - types: - - opened - - reopened - -env: - GITHUB_TOKEN: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} - CREATOR: ${{ github.event.pull_request.user.login }} - -jobs: - add-dependabot-request-to-project: - name: Add dependabot pull request to Senzing Community project - runs-on: ubuntu-latest - steps: - - name: Assign pull request to project - env: - BOOL: ${{ contains( env.CREATOR, 'dependabot' ) }} - uses: Senzing/github-action-add-issue-to-project@main - if: ${{ env.BOOL == 'true' }} - with: - project: "https://github.com/orgs/Senzing/projects/2" diff --git a/.github/workflows/add-issue-to-project-t-comm.yaml b/.github/workflows/add-issue-to-project-t-comm.yaml deleted file mode 100644 index 978d2b1..0000000 --- a/.github/workflows/add-issue-to-project-t-comm.yaml +++ /dev/null @@ -1,24 +0,0 @@ -# Based on -# - https://github.com/srggrs/assign-one-project-github-action - -name: add-issue-to-project-t-comm.yaml - -on: - issues: - types: - - reopened - - opened - -env: - GITHUB_TOKEN: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} - -jobs: - add-issue-to-project: - name: Add issue to Senzing Community project - runs-on: ubuntu-latest - steps: - - name: Assign issue to project - uses: Senzing/github-action-add-issue-to-project@main - with: - project: "https://github.com/orgs/Senzing/projects/2" - column_name: "Backlog" diff --git a/.github/workflows/identify-customer.yaml b/.github/workflows/add-label-customer-submission.yaml similarity index 68% rename from .github/workflows/identify-customer.yaml rename to .github/workflows/add-label-customer-submission.yaml index 2e9a0da..f9dd8e8 100644 --- a/.github/workflows/identify-customer.yaml +++ b/.github/workflows/add-label-customer-submission.yaml @@ -1,21 +1,17 @@ -name: identify-customer.yaml - +name: add-label-customer-submission.yaml on: issues: types: - opened - env: - GITHUB_TOKEN: ${{ secrets.ORG_MEMBERSHIP_TOKEN }} MEMBER_LIST: ${{ secrets.SENZING_MEMBERS }} CREATOR: ${{ github.actor }} - jobs: - identify-customer: - name: Add customer-submission label + automate-issues-labels: + name: Add customer-submission label to issue runs-on: ubuntu-latest steps: - - name: initial labeling + - name: Add customer-submission label env: BOOL: ${{ contains( env.MEMBER_LIST, env.CREATOR ) }} if: ${{ env.BOOL == 'false' }} diff --git a/.github/workflows/add-triage-label.yaml b/.github/workflows/add-label-triage.yaml similarity index 51% rename from .github/workflows/add-triage-label.yaml rename to .github/workflows/add-label-triage.yaml index bdbefae..fc32b8c 100644 --- a/.github/workflows/add-triage-label.yaml +++ b/.github/workflows/add-label-triage.yaml @@ -1,21 +1,15 @@ -# Based on -# - https://docs.github.com/en/actions/guides/adding-labels-to-issues -# - https://github.com/andymckay/labeler - -name: add-triage-label.yaml - +name: add-label-triage.yaml on: issues: types: - reopened - opened - jobs: - add-triage-label: + automate-issues-labels: name: Add triage label to issue runs-on: ubuntu-latest steps: - - name: initial labeling + - name: Add triage label uses: andymckay/labeler@1.0.4 with: add-labels: "triage" diff --git a/.github/workflows/add-to-project-garage-dependabot.yaml b/.github/workflows/add-to-project-garage-dependabot.yaml new file mode 100644 index 0000000..91cb367 --- /dev/null +++ b/.github/workflows/add-to-project-garage-dependabot.yaml @@ -0,0 +1,21 @@ +name: add-to-project-garage-dependabot.yaml +on: + pull_request: + types: + - opened + - reopened +env: + CREATOR: ${{ github.event.pull_request.user.login }} +jobs: + add-to-project: + name: Add dependabot pull request to project + runs-on: ubuntu-latest + steps: + - name: Assign pull request to project + env: + BOOL: ${{ contains( env.CREATOR, 'dependabot' ) }} + if: ${{ env.BOOL == 'true' }} + uses: actions/add-to-project@v0.5.0 + with: + project-url: https://github.com/orgs/senzing-garage/projects/3 + github-token: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} diff --git a/.github/workflows/add-to-project-garage.yaml b/.github/workflows/add-to-project-garage.yaml new file mode 100644 index 0000000..4599e4e --- /dev/null +++ b/.github/workflows/add-to-project-garage.yaml @@ -0,0 +1,16 @@ +name: add-to-project-garage.yaml +on: + issues: + types: + - reopened + - opened +jobs: + add-to-project: + name: Add issue to project + runs-on: ubuntu-latest + steps: + - name: Assign issue to project + uses: actions/add-to-project@v0.5.0 + with: + project-url: https://github.com/orgs/senzing-garage/projects/3 + github-token: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} diff --git a/.github/workflows/dependabot-approve-and-merge.yaml b/.github/workflows/dependabot-approve-and-merge.yaml index 114db76..a4574e4 100644 --- a/.github/workflows/dependabot-approve-and-merge.yaml +++ b/.github/workflows/dependabot-approve-and-merge.yaml @@ -1,10 +1,7 @@ ---- name: dependabot-approve-and-merge.yaml - on: pull_request: branches: [main] - jobs: dependabot-approve-and-merge: permissions: diff --git a/.github/workflows/docker-build-container.yaml b/.github/workflows/docker-build-container.yaml index 452ab48..4d343b8 100644 --- a/.github/workflows/docker-build-container.yaml +++ b/.github/workflows/docker-build-container.yaml @@ -1,11 +1,9 @@ name: docker-build-container.yaml - on: pull_request: branches: - main workflow_dispatch: - jobs: docker-build-container: runs-on: ubuntu-latest diff --git a/.github/workflows/docker-push-containers-to-dockerhub.yaml b/.github/workflows/docker-push-containers-to-dockerhub.yaml index ec13fd9..0400f9d 100644 --- a/.github/workflows/docker-push-containers-to-dockerhub.yaml +++ b/.github/workflows/docker-push-containers-to-dockerhub.yaml @@ -1,10 +1,8 @@ name: docker-push-containers-to-dockerhub.yaml - on: push: tags: - "[0-9]+.[0-9]+.[0-9]+" - jobs: docker-push-containers-to-dockerhub: runs-on: ubuntu-latest diff --git a/.github/workflows/move-pr-to-done.yaml b/.github/workflows/move-pr-to-done.yaml index a77c683..57fde8e 100644 --- a/.github/workflows/move-pr-to-done.yaml +++ b/.github/workflows/move-pr-to-done.yaml @@ -1,10 +1,7 @@ ---- name: move-pr-to-done.yaml - on: pull_request: types: [closed] - jobs: move-pr-to-done: uses: Senzing/build-resources/.github/workflows/move-pr-to-done.yaml@main diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80cdc5a..03f179b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,7 +82,7 @@ These variables may be modified, but do not need to be modified. The variables are used throughout the installation procedure. ```console -export GIT_ACCOUNT=senzing +export GIT_ACCOUNT=senzing-garage export GIT_REPOSITORY=docker-apt ``` diff --git a/Makefile b/Makefile index 22ff5bd..382efd5 100755 --- a/Makefile +++ b/Makefile @@ -23,7 +23,7 @@ default: help .PHONY: docker-build docker-build: docker build \ - --tag $(DOCKER_IMAGE_NAME) \ + --tag $(DOCKER_IMAGE_NAME) \ --tag $(DOCKER_IMAGE_NAME):$(GIT_VERSION) \ . @@ -31,7 +31,7 @@ docker-build: docker-build-staging: docker build \ --build-arg SENZING_APT_REPOSITORY_URL=$(SENZING_APT_STAGING_REPOSITORY_URL) \ - --tag $(DOCKER_IMAGE_NAME)-staging \ + --tag $(DOCKER_IMAGE_NAME)-staging \ --tag $(DOCKER_IMAGE_NAME)-staging:$(GIT_VERSION) \ . diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0b11a2f..0000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,13 +0,0 @@ -# Pull request questions - -## Which issue does this address - -Issue number: #nnn - -## Why was change needed - -??? - -## What does change improve - -??? diff --git a/README.md b/README.md index acba766..98ef248 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # docker-apt +If you are beginning your journey with +[Senzing](https://senzing.com/), +please start with +[Senzing Quick Start guides](https://docs.senzing.com/quickstart/). + +You are in the +[Senzing Garage](https://github.com/senzing-garage) +where projects are "tinkered" on. +Although this GitHub repository may help you understand an approach to using Senzing, +it's not considered to be "production ready" and is not considered to be part of the Senzing product. +Heck, it may not even be appropriate for your application of Senzing! + ## Synopsis A Docker wrapper over the `apt` command. @@ -35,12 +47,12 @@ The default behavior is to install the latest `senzingapi` packages. At [Senzing](http://senzing.com), we strive to create GitHub documentation in a -"[don't make me think](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/dont-make-me-think.md)" style. +"[don't make me think](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/dont-make-me-think.md)" style. For the most part, instructions are copy and paste. Whenever thinking is needed, it's marked with a "thinking" icon :thinking:. Whenever customization is needed, it's marked with a "pencil" icon :pencil2:. If the instructions are not clear, please let us know by opening a new -[Documentation issue](https://github.com/Senzing/docker-apt/issues/new?template=documentation_request.md) +[Documentation issue](https://github.com/senzing-garage/docker-apt/issues/new?template=documentation_request.md) describing where we can improve. Now on with the show... ### Legend @@ -54,14 +66,14 @@ describing where we can improve. Now on with the show... ## Related artifacts 1. [DockerHub](https://hub.docker.com/r/senzing/apt) -1. [Helm Chart](https://github.com/Senzing/charts/tree/main/charts/senzing-apt) +1. [Helm Chart](https://github.com/senzing-garage/charts/tree/main/charts/senzing-apt) ## Expectations - **Space:** This repository and demonstration require 6 GB free disk space. - **Time:** Budget 10 minutes to get the demonstration up-and-running, depending on CPU and network speeds. - **Background knowledge:** This repository assumes a working knowledge of: - - [Docker](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/docker.md) + - [Docker](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/docker.md) ## Demonstrate using Docker @@ -73,7 +85,7 @@ To use the Senzing code, you must agree to the End User License Agreement (EULA) This ensures that you make a conscious effort to accept the EULA. Example: - 
export SENZING_ACCEPT_EULA="<the value from this link>"
+ 
export SENZING_ACCEPT_EULA="<the value from this link>"
### Docker volumes @@ -88,10 +100,10 @@ Environment variables will be used in `--volume` options to externalize the inst ``` 1. :warning: - **macOS** - [File sharing](https://github.com/Senzing/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#macos) + **macOS** - [File sharing](https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#macos) must be enabled for `SENZING_VOLUME`. 1. :warning: - **Windows** - [File sharing](https://github.com/Senzing/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#windows) + **Windows** - [File sharing](https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#windows) must be enabled for `SENZING_VOLUME`. ### Run Docker container @@ -120,14 +132,14 @@ The following instructions are used when modifying and building the Docker image These are "one-time tasks" which may already have been completed. 1. The following software programs need to be installed: - 1. [git](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/git.md) - 1. [make](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/make.md) - 1. [docker](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/docker.md) + 1. [git](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/git.md) + 1. [make](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/make.md) + 1. [docker](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/docker.md) ### Clone repository For more information on environment variables, -see [Environment Variables](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md). +see [Environment Variables](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md). 1. Set these environment variable values: @@ -138,7 +150,7 @@ see [Environment Variables](https://github.com/Senzing/knowledge-base/blob/main/ export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}" ``` -1. Using the environment variables values just set, follow steps in [clone-repository](https://github.com/Senzing/knowledge-base/blob/main/HOWTO/clone-repository.md) to install the Git repository. +1. Using the environment variables values just set, follow steps in [clone-repository](https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/clone-repository.md) to install the Git repository. ### Build Docker image @@ -147,7 +159,7 @@ see [Environment Variables](https://github.com/Senzing/knowledge-base/blob/main/ ```console sudo docker build \ --tag senzing/apt \ - https://github.com/senzing/docker-apt.git#main + https://github.com/senzing-garage/docker-apt.git#main ``` 1. **Option #2:** Using `docker` command and local repository. @@ -194,7 +206,7 @@ By not setting `SENZING_ACCEPT_EULA_PARAMETER`, the containerized `yum` install `senzing/apt` can be used to install local DEB files. 1. To download Senzing DEB file, see - [github.com/Senzing/docker-aptdownloader](https://github.com/Senzing/docker-aptdownloader). + [github.com/Senzing/docker-aptdownloader](https://github.com/senzing-garage/docker-aptdownloader). 1. :pencil2: Set additional environment variables. Identify directory containing DEB files and the exact names of the DEB files. @@ -226,12 +238,12 @@ By not setting `SENZING_ACCEPT_EULA_PARAMETER`, the containerized `yum` install Configuration values specified by environment variable or command line parameter. -- **[SENZING_ACCEPT_EULA](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_accept_eula)** -- **[SENZING_API_DEB_FILENAME](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_api_deb_filename)** -- **[SENZING_DATA_DIR](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_data_dir)** -- **[SENZING_DATA_DEB_FILENAME](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_data_deb_filename)** -- **[SENZING_DEB_DIR](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_deb_dir)** -- **[SENZING_G2_DIR](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_g2_dir)** +- **[SENZING_ACCEPT_EULA](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_accept_eula)** +- **[SENZING_API_DEB_FILENAME](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_api_deb_filename)** +- **[SENZING_DATA_DIR](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_data_dir)** +- **[SENZING_DATA_DEB_FILENAME](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_data_deb_filename)** +- **[SENZING_DEB_DIR](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_deb_dir)** +- **[SENZING_G2_DIR](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_g2_dir)** ## Errors