forked from ontoportal/ontologies_api
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature: Add OntoPortal API deployment CI (#88)
* Feature: mappings statistics slices support (#78) * restrict mapping statistics ontologies to the ontologies of the current slice * add a test for the mappings slices support * add test for mappings statistics slices support * update owl wrapper version to v1.4.3 * update test search multilingual test to ensure selecting one prefLabel * add filter search results attributes by language * add search multiple languages or all languages tests * implement display search results in multiple languages * fix annotator prefLabel language selection * fix: remove duplicated agents endpoint ('/Agents') (#85) * Feature: implement ontology agents endpoint (#84) * implement ontology agents endpoint * Move ontology agents method out of agents namespace in agents_controller * return a list of uniq values, for the endpoint '/ontologies/:acronym/agents' that contains all the agents of the ontology using agents_attrs list * test for ontology agents endpoing * add another ontologyin test ontology agents test, and assert only the number of results and the names --------- Co-authored-by: Bilel KIHAL <[email protected]> * update API deploy CI to SSH jump host and get configs from private repo * update deploy files and add agroportal, stage and test environments * Feature: update agents search endpoint to add option to have a custom qf paramter (#90) * fix agents search sensibility * improve agents search endpoint to search only exact string or substring match * make the agent search endpoint query filter configurable --------- Co-authored-by: Syphax <[email protected]> * Fix: hide duplicated agents endpoint ('/Agents') (#91) * remove duplicated agents endpoint ('/Agents') * put again the Agents endpoint * hide Agents endpoint in the home endpoint * fix properties tests --------- Co-authored-by: Bilel KIHAL <[email protected]> --------- Co-authored-by: Bilel Kihal <[email protected]> Co-authored-by: Bilel KIHAL <[email protected]>
- Loading branch information
3 people
authored
Aug 8, 2024
1 parent
77926d5
commit 189a35c
Showing
18 changed files
with
455 additions
and
271 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,92 @@ | ||
| # Workflow for deploying ontologies_api to stage/prod systems via capistrano. | ||
| # This workflow runs after a successeful execution of the unit test workflow and it | ||
| # can also be triggered manually. | ||
| # Workflow to deploy OntoPortal API to stage/prod systems | ||
| # | ||
| # Required github secrets: | ||
| # | ||
| # CONFIG_REPO - github repo containing config and customizations for the API. Format 'author/private_config_repo' | ||
| # CONFIG_REPO - github repo containing config and customizations for API. Format 'author/private_config_repo' | ||
| # it is used for getting capistrano deployment configuration for stages on the github actions runner and | ||
| # PRIVATE_CONFIG_REPO env var is constructed from it which is used by capistrano on the remote servers for pulling configs. | ||
| # PRIVATE_CONFIG_REPO env var is constructed from it which is used by capistrano on the API hosts for pulling configs. | ||
| # | ||
| # GH_PAT - github Personal Access Token for accessing PRIVATE_CONFIG_REPO | ||
| # GH_PAT - github Personal Access Token for accessing private config repo | ||
| # | ||
| # SSH_JUMPHOST - ssh jump/proxy host though which deployments have to though if app servers are hosted on private network. | ||
| # SSH_JUMPHOST - ssh jump/proxy host though which deployments have to though if API nodes live on private network. | ||
| # SSH_JUMPHOST_USER - username to use to connect to the ssh jump/proxy. | ||
| # | ||
| # DEPLOY_ENC_KEY - key for decrypting deploymnet ssh key residing in config/deploy_id_rsa_enc (see miloserdow/capistrano-deploy) | ||
| # this SSH key is used for accessing jump host, UI nodes, and private github repo. | ||
| # DEPLOY_ENC_KEY - key for decrypting deploymnet ssh key residing in config/ | ||
| # this SSH key is used for accessing jump host, API nodes, and private github repo. | ||
|
|
||
| name: Capistrano Deployment | ||
| # Controls when the action will run. | ||
| on: | ||
| # Trigger deployment to staging after unit test action completes | ||
| workflow_run: | ||
| workflows: ["Ruby Unit Tests"] | ||
| types: | ||
| - completed | ||
| branches: [master, develop] | ||
| push: | ||
| branches: | ||
| - stage | ||
| - test | ||
| # Allows running this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
| branches: [master, develop] | ||
| inputs: | ||
| BRANCH: | ||
| description: 'Branch/tag to deploy' | ||
| default: develop | ||
| description: "Branch/tag to deploy" | ||
| options: | ||
| - stage | ||
| - test | ||
| - master | ||
| default: stage | ||
| required: true | ||
| environment: | ||
| description: 'target environment to deploy to' | ||
| description: "target environment to deploy to" | ||
| type: choice | ||
| options: | ||
| - staging | ||
| - production | ||
| default: staging | ||
|
|
||
| - agroportal | ||
| - test | ||
| default: stage | ||
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| # run deployment only if "Ruby Unit Tests" workflow completes sucessefully or when manually triggered | ||
| if: ${{ (github.event.workflow_run.conclusion == 'success') || (github.event_name == 'workflow_dispatch') }} | ||
| env: | ||
| BUNDLE_WITHOUT: default #install gems required primarily for the deployment in order to speed this workflow | ||
| BUNDLE_WITHOUT: default #install gems required primarely for deployment in order to speed up workflow | ||
| PRIVATE_CONFIG_REPO: ${{ format('[email protected]:{0}.git', secrets.CONFIG_REPO) }} | ||
| # Steps represent a sequence of tasks that will be executed as part of the job | ||
| steps: | ||
| - name: set branch/tag and environment to deploy from inputs | ||
| run: | | ||
| # workflow_dispatch default input doesn't get set on push so we need to set defaults | ||
| # via shell parameter expansion | ||
| # https://dev.to/mrmike/github-action-handling-input-default-value-5f2g | ||
| USER_INPUT_BRANCH=${{ inputs.branch }} | ||
| echo "BRANCH=${USER_INPUT_BRANCH:-develop}" >> $GITHUB_ENV | ||
| USER_INPUT_ENVIRONMENT=${{ inputs.environment }} | ||
| echo "TARGET=${USER_INPUT_ENVIRONMENT:-staging}" >> $GITHUB_ENV | ||
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | ||
| - uses: actions/checkout@v3 | ||
| - uses: ruby/setup-ruby@v1 | ||
| with: | ||
| ruby-version: 2.7.6 # Not needed with a .ruby-version file | ||
| bundler-cache: true # runs 'bundle install' and caches installed gems automatically | ||
| - name: get-deployment-config | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| repository: ${{ secrets.CONFIG_REPO }} # repository containing deployment settings | ||
| token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT | ||
| path: deploy_config | ||
| - name: copy-deployment-config | ||
| run: cp -r deploy_config/ontologies_api/* . | ||
| # add ssh hostkey so that capistrano doesn't complain | ||
| - name: Add jumphost's hostkey to Known Hosts | ||
| run: | | ||
| mkdir -p ~/.ssh | ||
| ssh-keyscan -H ${{ secrets.SSH_JUMPHOST }} > ~/.ssh/known_hosts | ||
| shell: bash | ||
| - uses: miloserdow/capistrano-deploy@master | ||
| with: | ||
| target: ${{ env.TARGET }} # which environment to deploy | ||
| deploy_key: ${{ secrets.DEPLOY_ENC_KEY }} # Name of the variable configured in Settings/Secrets of your github project | ||
| - name: set branch/tag and environment to deploy from inputs | ||
| run: | | ||
| # workflow_dispatch default input doesn't get set on push so we need to set defaults | ||
| # via shell parameter expansion | ||
| # https://dev.to/mrmike/github-action-handling-input-default-value-5f2g | ||
| USER_INPUT_BRANCH=${{ inputs.branch }} | ||
| echo "BRANCH=${USER_INPUT_BRANCH:github.head_ref:-master}" >> $GITHUB_ENV | ||
| USER_INPUT_ENVIRONMENT=${{ inputs.environment }} | ||
| echo "TARGET=${USER_INPUT_ENVIRONMENT:-staging}" >> $GITHUB_ENV | ||
| CONFIG_REPO=${{ secrets.CONFIG_REPO }} | ||
| GH_PAT=${{ secrets.GH_PAT }} | ||
| echo "PRIVATE_CONFIG_REPO=https://${GH_PAT}@github.com/${CONFIG_REPO}" >> $GITHUB_ENV | ||
| echo "SSH_JUMPHOST=${{ secrets.SSH_JUMPHOST }}" >> $GITHUB_ENV | ||
| echo "SSH_JUMPHOST_USER=${{ secrets.SSH_JUMPHOST_USER }}" >> $GITHUB_ENV | ||
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | ||
| - uses: actions/checkout@v3 | ||
| - uses: ruby/setup-ruby@v1 | ||
| with: | ||
| ruby-version: 2.7.6 # Not needed with a .ruby-version file | ||
| bundler-cache: true # runs 'bundle install' and caches installed gems automatically | ||
| - name: get-deployment-config | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| repository: ${{ secrets.CONFIG_REPO }} # repository containing deployment settings | ||
| token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT | ||
| path: deploy_config | ||
| - name: copy-deployment-config | ||
| run: cp -r deploy_config/ontologies_api/${{ inputs.environment }}/* . | ||
| # add ssh hostkey so that capistrano doesn't complain | ||
| - name: Add jumphost's hostkey to Known Hosts | ||
| run: | | ||
| mkdir -p ~/.ssh | ||
| echo "${{ secrets.SSH_JUMPHOST }}" | ||
| ssh-keyscan -H ${{ secrets.SSH_JUMPHOST }} > ~/.ssh/known_hosts | ||
| shell: bash | ||
| - uses: miloserdow/capistrano-deploy@master | ||
| with: | ||
| target: ${{ env.TARGET }} # which environment to deploy | ||
| deploy_key: ${{ secrets.DEPLOY_ENC_KEY }} # Name of the variable configured in Settings/Secrets of your github project |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.