Skip to content

Check PAT value before when required by CI workflow step #19673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

perangel
Copy link
Contributor

What

Per Github's documentation

If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue

This means that anywhere that we declare an if condition for a run, we need to also check that the output of find_valid_pat is not empty.

How

This PR adds a check for the value of the find_valid_pat output anywhere that find_valid_pat is declared as a prerequisite and an if-condition is used to determine whether a step should run.

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

Per the Github docs:

  If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue.

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idneeds
@perangel perangel temporarily deployed to more-secrets November 21, 2022 20:45 Inactive
@perangel
Copy link
Contributor Author

There may be a Github-ism that makes more sense for this. If anyone has an idea for an alternative, please let me know. This feels like a hack

@perangel perangel temporarily deployed to more-secrets November 22, 2022 15:09 Inactive
@perangel perangel force-pushed the perangel/abc-3569/find-a-pat-script-should-fail-build branch from a18199c to 20fb06b Compare November 22, 2022 18:36
@perangel perangel marked this pull request as ready for review November 22, 2022 18:36
@perangel perangel temporarily deployed to more-secrets November 22, 2022 18:39 Inactive
@perangel perangel requested a review from a team November 23, 2022 17:27
@c-p-b
Copy link

c-p-b commented Nov 23, 2022

Can we confirm whether this actually works? My understanding is that as long as always() exists it will always run the workflow no matter what. Is that an incorrect assumption? I think we need to get rid of the always() clause - but I might be wrong here.

@Mykyta-Serbynevskyi
Copy link
Contributor

Hi @perangel @cpdeethree
FYI - The changes in this PR will no longer work since find_valid_pat job has been removed from gradle.yml in #19736 due to PAT leaking behavior in logs, details are in https://github.com/airbytehq/airbyte-cloud/issues/3587

@perangel perangel closed this Feb 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants