search

pantheon-systems / circleci-orb

Use CircleCI to push code to Pantheon Dev and Multidev Environments
10 stars 18 forks source link

Document env vars needed when retrofitting to existing non-build-tools sites #68

Closed dustinleblanc closed 6 months ago

dustinleblanc commented 6 months ago

I've retrofitted this orb into a few sites run via Bitbucket + CircleCI + Pantheon that were using home-grown "Build tools inspired" CircleCI scripts that had become too cumbersome to maintain and slow in builds. It mostly worked flawlessly except that the Build Tools commands being used by the push command need to interact with the Bitbucket API to perform branch deletion tasks. These API calls were failing because I had not set the BITBUCKET_USER and BITBUCKET_PASS environment variables in CircleCI. Adding these env vars seems to have resolved the problem, but I had to go hunting in the code of the build tools plugin to discover what I was missing. I recommend adding these (and likely the GITHUB_TOKEN for users on GIthub, etc) to the readme to ensure retrofitters such as myself don't run into similar headaches.

kporras07 commented 6 months ago

Hi @dustinleblanc now that the info is fresh in your mind, would you mind drafting a PR with that info and we could come back later and fill in the Github part? That would be super appreciated!

dustinleblanc commented 6 months ago

Sure!

dustinleblanc commented 6 months ago

quick PR opened!

rwagner00 commented 6 months ago

@dustinleblanc PR was merged and github auto-closed this issue. Can it stay closed or does it need to be re-opened?

dustinleblanc commented 6 months ago

My personal need is well documented now, but the team may want to consider re-opening to document similar configuration needs, or opening a follow up issue to do so