Skip to content

Improve helper example section with env var usage #1580

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
wants to merge 1 commit into from

Conversation

glennie
Copy link

@glennie glennie commented Aug 29, 2021

Hi,
I wanted to use an env var for the token.
I spend some time to figure out that I needed to escape '%' because of configparser.
Therefore, I made this PR to improve the current documentation hoping others will spend much less time than me.
Kind regards,

@glennie glennie force-pushed the patch-1 branch 2 times, most recently from a8e7060 to b9722c8 Compare August 29, 2021 13:05
Added an example for using envrionement variable for tokens.
@glennie glennie changed the title Update cli-usage.rst Improve helper example section with env var usage Aug 29, 2021
Comment on lines +185 to +191
private_token = helper: printf -- '%%s' ${GITLAB_TOKEN}
timeout = 1

**Notice:**

* ``printf`` is the executable provided by coreutils package (on a debian based distribution).
* ``%`` must be escaped using an other `%` (in order to allow `configparser` load configuration properly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this contribution @glennie! Initially I wanted to say this would probably be superseded by #1296, but I like your idea because you can define multiple env vars (e.g. one per gitlab id entry).

Just one question: Wouldn't simply using echo -n ${VARIABLE} achieve the same? Have you tried this? -n should strip the newline.

@github-actions
Copy link

github-actions bot commented Jan 8, 2022

This Pull Request (PR) was marked stale because it has been open 90 days with no activity. Please remove the stale label or comment on this PR. Otherwise, it will be closed in 15 days.

@github-actions github-actions bot added the stale label Jan 8, 2022
@github-actions
Copy link

This PR was closed because it has been marked stale for 15 days with no activity. If this PR is still valid, please re-open.

@github-actions github-actions bot closed this Jan 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants