Skip to content
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

docs(readme): rewrite #846

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Conversation

HonkingGoose
Copy link
Contributor

Changes:

  • Drop badges
  • Drop Table of Contents, GitHub has a UI button to show you the auto-generated table of content
  • Rewrite most content
  • Explain how the versions of the action and of the main Renovate program are different
  • Use GitHub Markdown Alerts to call out important info

Context:

Adds info I asked about in:

Please review thoroughly for technical correctness!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@HonkingGoose HonkingGoose requested a review from viceice June 6, 2024 12:23
@@ -353,9 +352,9 @@ For example:

## Environment Variables

If you wish to pass through environment variables through to the Docker container that powers this action you need to prefix the environment variable with `RENOVATE_`.
To pass through environment variables through to the Docker container that powers this action, you must prefix the environment variable with `RENOVATE_`.
Copy link
Member

Choose a reason for hiding this comment

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

we should remove this must prefix, it's totally wrong and we should not suggest that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
To pass through environment variables through to the Docker container that powers this action, you must prefix the environment variable with `RENOVATE_`.
If you wish to pass environment variables to the Docker container that powers this action, prefix the environment variable with `RENOVATE_`.

Is this what you want?

Copy link
Member

Choose a reason for hiding this comment

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

no, remove the prefix suggestion completely. I know it's going worse for now but I don't like to suggest a totally wrong configuration.

we can leave the sample for now, or maybe better also remove it. I'll probably doing some changes when I'm back at work.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll let you push the changes to my branch then! 😉

Copy link
Member

Choose a reason for hiding this comment

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

then it has to wait until next week. ⛱️🍹

@viceice

This comment was marked as resolved.

@HonkingGoose
Copy link
Contributor Author

@viceice I resolved the merge conflict, I'll let you push the changes you want to my branch. 😉

@viceice viceice self-requested a review July 3, 2024 15:43
Comment on lines +502 to 507
# Unfortunately, the permissions expected within Renovate's Docker container
# are different than the ones given after the cache is restored. We must
# change ownership to solve this. We also must have the correct permissions in
# the entire /tmp/renovate tree, not just the section with the repo cache.
sudo chown -R runneradmin:root /tmp/renovate/
ls -R $cache_dir
Copy link

Choose a reason for hiding this comment

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

This seems to no longer work. On the other hand, there is now a docker-user option.

I am now using the following:

      - name: Determine current user
        id: id
        run: |
          echo "user=$(id -u)" >> $GITHUB_OUTPUT
          echo "group=$(id -g)" >> $GITHUB_OUTPUT
      - uses: renovatebot/github-action@v40.3.4
        with:
          configurationFile: renovate.json5
          token: ${{ secrets.RENOVATE_TOKEN }}
          renovate-version: 37.421.3
          # used to mount cache
          docker-user: "${{ steps.id.outputs.user }}:${{ steps.id.outputs.group }}"
          docker-volumes: |
            /tmp/renovate/cache:/tmp/renovate/cache
        env:
          # This enables the cache -- if this is set, it's not necessary to add it to renovate.json.
          RENOVATE_REPOSITORY_CACHE: ${{ github.event.inputs.repoCache || 'enabled' }}

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