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: Document Isso Project Infrastructure #1013

Merged
merged 1 commit into from
Apr 23, 2024
Merged

Conversation

ix5
Copy link
Member

@ix5 ix5 commented Apr 21, 2024

Checklist

  • All new and existing tests are passing
  • (If adding features:) I have added tests to cover my changes
  • (If docs changes needed:) I have updated the documentation accordingly.
  • I have added an entry to CHANGES.rst because this is a user-facing change or an important bugfix
  • I have written proper commit message(s)

What changes does this Pull Request introduce?

Try to codify the new reality of the project since Martin stepped down and make sense of all the informal or mostly-one-off processes we are currently running.

I've also created isso-demo-config and isso-marketing-material as well as linked ansible-role-isso to coincide with this PR.

Why is this necessary?

Brought about by recent events, I thought about the nature of maintainership a bit and realized that we have a) a pretty significant bus factor and b) our infra could be a bit opaque to newcomers. Collecting all the information and writing it down in one place also might help highlight a few blind spots and areas for improvement.

@ix5 ix5 added docs Documentation of the project meta Concerning the general direction and organisation of the project labels Apr 21, 2024
@ix5 ix5 requested review from jelmer and posativ April 21, 2024 23:28
@ix5 ix5 force-pushed the docs-infra branch 2 times, most recently from e092c29 to 7c19798 Compare April 21, 2024 23:50
Copy link
Member

@jelmer jelmer left a comment

Choose a reason for hiding this comment

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

Deleted

docs/docs/contributing/infrastructure.rst Outdated Show resolved Hide resolved
docs/docs/contributing/infrastructure.rst Outdated Show resolved Hide resolved
@posativ
Copy link
Collaborator

posativ commented Apr 22, 2024

LGTM, I just checked PyPi and @blatinier has the Maintainer role, do we need to change this? Is there any point to making an organization on PyPi?

@jelmer
Copy link
Member

jelmer commented Apr 22, 2024

LGTM, I just checked PyPi and @blatinier has the Maintainer role, do we need to change this? Is there any point to making an organization on PyPi?

I think organizations are still an experimental feature that needs to be requested and are hard to get.

@ix5
Copy link
Member Author

ix5 commented Apr 23, 2024

LGTM, I just checked PyPi and @blatinier has the Maintainer role, do we need to change this? Is there any point to making an organization on PyPi?

Mainainer role is sufficient for releases afaics. Also seems that Benoit is no longer much (if at all) involved with the project.

I think organizations are still an experimental feature that needs to be requested and are hard to get.

Yes, also I don't immediately see the added benefit of that feature for us.

We might investigate using the "Publish from GitHub" feature (direct link: "Trusted Publisher Management" for isso). That might simplify releasing new versions further, since we already publish docker images on any git tag.

OpenID Connect (OIDC) provides a flexible, credential-free mechanism for delegating publishing authority for a PyPI package to a trusted third party service, like GitHub Actions.

PyPI users and projects can use trusted publishers to automate their release processes, without needing to use API tokens or passwords.

Try to codify the new reality of the project since Martin
stepped down and make sense of all the informal or
mostly-one-off processes we are currently running.

Brought about by recent events, I (@ix5) thought about the
nature of maintainership a bit and realized that we have a)
a pretty significant bus factor and b) our infra could be a
bit opaque to newcomers. Collecting all the information and
writing it down in one place also might help highlight a few
blind spots and areas for improvement.
@ix5 ix5 merged commit 4560a1d into isso-comments:master Apr 23, 2024
12 of 15 checks passed
@ix5 ix5 deleted the docs-infra branch April 23, 2024 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation of the project meta Concerning the general direction and organisation of the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants