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

Add configurable known issues #110

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

Conversation

Laupetin
Copy link

This adds the feature to add known issues to the configuration that can be referenced by an alias.
This makes it possible to for example reference a commonly used ticket like one to book recurring meetings on without having to remember the ticket number.

This PR adds the new feature to the YAML format only for now since i am not familiar with the Buch format. If it also should be implemented there, let me know.

@BuJo
Copy link
Member

BuJo commented Oct 30, 2022

Generally I like the idea.
I think it needs a little bit of time to think how it interacts with

  • the way parsers are configured
    Top level configs and growing parameters to the initializers
  • the way parsers interact with the data format, issue being a number normally
  • It might be that the resolver infrastructure isn't good enough but might be the better place
  • the way it would interact syntax wise with the idea of being able to enter times on projects instead of issues

@BuJo
Copy link
Member

BuJo commented Oct 31, 2022

Let's tag this as hacktoberfest-accepted, as it basically could be merged just like this. However, the code surrounding this feature could be better integrated... Let's not rush this out the door just yet.

@Laupetin
Copy link
Author

Laupetin commented Nov 25, 2022

So the issue aliases now make use of resolvers, so they can be added optionally.
To make this work i had to move some of the features of the yaml parser to new resolvers to make the parser accept more input data that can then be resolved.

I did make these new resolvers be enabled by default to not make it so existing workflows no longer work without adding the new resolver via the configuration.
I hope that's an okay approach.

It might be a good idea to test whether this broke any existing workflows, i'm afraid i can only be sure about my own one.

@Laupetin Laupetin force-pushed the configured-issues branch 2 times, most recently from 6844a42 to 9fcc19f Compare November 25, 2022 14:38
@Laupetin Laupetin force-pushed the configured-issues branch from 7c3c863 to 3a656e3 Compare July 28, 2023 06:30
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