Skip to content

Conversation

@stmontgomery
Copy link
Contributor

This includes a handful of updates and edits to process.md which documents the Swift evolution process so that it mentions Swift Testing, the Testing Workgroup, and the newly-added Swift Testing template file.

@stmontgomery stmontgomery added the evolution process A change to the meta-content of evolution, e.g. the process documentation or templates label Mar 6, 2025
@stmontgomery stmontgomery self-assigned this Mar 6, 2025
@stmontgomery stmontgomery added the TWG Contains topics under the domain of the Testing Workgroup label Mar 6, 2025
@dempseyatgithub
Copy link
Contributor

dempseyatgithub commented Mar 8, 2025

@stmontgomery If you are making changes to the contents of the proposals directory, please give me a head's up. I am the maintainer of the swift-evolution-metadata-extractor tool and the evolution dashboard.

Unexpected changes to the proposals directory like adding the testing directory can break the tool that updates the Swift Evolution Dashboard. (As it currently is broken)

In general, I know there is a plan to bring more projects into the evolution process.

It would be great to have some warning ahead of time of what changes are coming and when, so that I can make sure ahead of time that the evolution dashboard doesn't break.

(And I realize this comment is not directly related to this PR, but there's no way to comment on the commit that caused the break itself.)

@hborla
Copy link
Member

hborla commented Mar 10, 2025

@dempseyatgithub

If you are making changes to the contents of the proposals directory, please give me a head's up. I am the maintainer of the swift-evolution-metadata-extractor tool and the evolution dashboard.

I'm sorry about that, I was the one who approved and merged the addition of the testing directory which broke the Swift Evolution Dashboard last week. Next time, I will file an issue in swift-evolution-metadata-extraction to track necessary updates to the tool before merging changes to the proposals directory. That said:

Unexpected changes to the proposals directory like adding the testing directory can break the tool that updates the Swift Evolution Dashboard. (As it currently is broken)

I fixed the Swift Evolution Dashboard on Friday in swiftlang/swift-evolution-metadata-extractor#48, and the dashboard appears to be working now. It skips all proposals in the testing subdirectory, which was deliberate in my change. In what way is the dashboard still broken? I am happy to fix it myself since I'm the one who broke it! I can also file an issue over in swift-evolution-metadata-extraction to discuss this since it is not related to this specific PR.

Copy link
Contributor

@rjmccall rjmccall left a comment

Choose a reason for hiding this comment

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

I'm mostly just taking the prompt here to document some other long-established changes.

@stmontgomery
Copy link
Contributor Author

If you are making changes to the contents of the proposals directory, please give me a head's up. I am the maintainer of the swift-evolution-metadata-extractor tool and the evolution dashboard.
[…]
It would be great to have some warning ahead of time of what changes are coming and when, so that I can make sure ahead of time that the evolution dashboard doesn't break.

Absolutely, understood, @dempseyatgithub. As @hborla mentioned, we collaborated on #2721 (which is what added content under /proposals/testing), and neither of us realized the impact ahead of time. Now I know, and will give you a heads up!

Now, while we're on the topic: I am hoping we can teach swift-evolution-metadata-extractor how to begin displaying those Swift Testing proposals on the Evolution dashboard as soon as possible. Since I've been coordinating many of the launch details for the new workgroup I was planning to volunteer to contribute changes to accomplish that, but I'm also happy if you'd like to do it @dempseyatgithub. Either way, I just filed swiftlang/swift-evolution-metadata-extractor#49 to track it.

@stmontgomery stmontgomery requested a review from rjmccall March 10, 2025 21:50
@stmontgomery
Copy link
Contributor Author

@rjmccall @hborla I've incorporated feedback on this process document so it's ready for review again and hopefully landing at this point. Thanks!

stmontgomery added a commit to stmontgomery/swift-evolution that referenced this pull request Mar 10, 2025
This is a small PR to replace two links in `process.md` which still reference the Apple GitHub organization instead of swiftlang. (I noticed these while working on swiftlang#2729 but they were out of scope for that PR.) The existing links aren't broken, they do redirect successfully, but it's nicer to use the correct URLs.
@allevato
Copy link
Member

It would be great to have some warning ahead of time of what changes are coming and when, so that I can make sure ahead of time that the evolution dashboard doesn't break.

How difficult would it be to set up a GitHub action for PRs that checks to make sure the metadata extractor works as expected? If changes to the repo risk breaking the extractor, having a pre-merge check seems like a good way to mitigate that risk.

@FranzBusch
Copy link
Member

@shahmishal can we enable GHA here on this repo?

@shahmishal
Copy link
Member

Yes, we should be able to. I will work with @dempseyatgithub to configure the right testing for the swift-evolution repository.

Copy link
Contributor

@rjmccall rjmccall left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

evolution process A change to the meta-content of evolution, e.g. the process documentation or templates TWG Contains topics under the domain of the Testing Workgroup

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants