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

Maintenance: Monthly reminder to update roadmap #4074

Closed
2 tasks done
heitorlessa opened this issue Apr 5, 2024 · 5 comments · Fixed by #4075
Closed
2 tasks done

Maintenance: Monthly reminder to update roadmap #4074

heitorlessa opened this issue Apr 5, 2024 · 5 comments · Fixed by #4075
Labels
internal Maintenance changes

Comments

@heitorlessa
Copy link
Contributor

Why is this needed?

As part of governance to keep public roadmap up to date.

Which area does this relate to?

Other

Solution

No response

Acknowledgment

@heitorlessa heitorlessa added triage Pending triage from maintainers internal Maintenance changes labels Apr 5, 2024
@heitorlessa heitorlessa removed the triage Pending triage from maintainers label Apr 5, 2024
@leandrodamascena leandrodamascena linked a pull request Apr 5, 2024 that will close this issue
7 tasks
@github-project-automation github-project-automation bot moved this from Triage to Coming soon in Powertools for AWS Lambda (Python) Apr 5, 2024
Copy link
Contributor

github-actions bot commented Apr 5, 2024

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label Apr 5, 2024
@heitorlessa heitorlessa moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Apr 5, 2024
@heitorlessa heitorlessa reopened this Apr 5, 2024
@github-project-automation github-project-automation bot moved this from Shipped to Pending review in Powertools for AWS Lambda (Python) Apr 5, 2024
@heitorlessa
Copy link
Contributor Author

Reopening as there's some fixes to port from another branch, and to share lessons learned in this.

@heitorlessa
Copy link
Contributor Author

Main lesson learned is that when using cross-repo workflows that use local scripts, we must change the checkout in the target workflow to explicitly checkout itself.

What do I mean by that?

Take the following job in mind

jobs:
    call-workflow-passing-data:
        permissions:
            contents: read
            pull-requests: read
            issues: write  # create monthly roadmap report
        uses: aws-powertools/actions/.github/workflows/monthly_roadmap_reminder.yml@main
        secrets:
            token: ${{ secrets.GITHUB_TOKEN }}

There are two implicit designs that aren't easy to understand at first and docs don't call that out:

  1. aws-powertools/actions is where the workflow is
  2. monthly_roadmap_reminder.yml is the workflow name
  3. The workflow runs in this repository

With that in mind, the target workflow naturally would try to do a code checkout as its first step. However, that code checkout will checkout this repository (Python source code), not the shared actions we want.

For this to work, the target workflow owned by aws-powertools/actions must explicitly pass which repository it will checkout code -- it can't be via ${{github.repo}} because it would resolve to powertools-lambda-python.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633  # v4.1.2
        with:
            # NOTE Since it's called from another repository
            # we must checkout the repository where the github-script is (aws-powertools/actions)
            # otherwise the caller check out their own repository code (e.g., Python/TS), where the github-scripts aren't available
            repository: aws-powertools/actions

A nicer benefit of this is that we don't need to control from the target who can call it and try to abuse creating GitHub issues in another place, because it's the caller repository that runs the workflow (it's not a fire-n-forget).

Copy link
Contributor

This is now released under 2.37.0 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label Apr 18, 2024
@github-project-automation github-project-automation bot moved this from Pending review to Coming soon in Powertools for AWS Lambda (Python) Apr 18, 2024
@leandrodamascena leandrodamascena moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Apr 19, 2024
@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label May 2, 2024
Copy link
Contributor

This is now released under 2.38.0 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Maintenance changes
Projects
Status: Shipped
Development

Successfully merging a pull request may close this issue.

1 participant