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.

Sign up for GitHub

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

Jump to bottom

Add support for markdown format output #315

Merged
merged 8 commits into from
Sep 8, 2023
Merged

Add support for markdown format output #315

merged 8 commits into from
Sep 8, 2023

Conversation

sandrobonazzola
Copy link
Contributor

Add markdown format output and enable it for bugzilla, github and gitlab.

kwk
kwk reviewed Sep 5, 2023
View reviewed changes
Copy link
Collaborator

@kwk kwk left a comment

Choose a reason for hiding this comment

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

Niced idea. I have some just some minor thoughts.

did/cli.py Outdated Show resolved Hide resolved
did/utils.py Outdated Show resolved Hide resolved
psss
psss requested changes Sep 8, 2023
View reviewed changes
Copy link
Owner

@psss psss left a comment

Choose a reason for hiding this comment

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

Nice improvement! Thanks for implementing this. Added just a few, rather minor, comments.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
did/plugins/gitlab.py Outdated Show resolved Hide resolved
did/plugins/gitlab.py Outdated Show resolved Hide resolved
did/cli.py Outdated Show resolved Hide resolved
did/cli.py Outdated Show resolved Hide resolved
@psss psss added this to the 0.21 milestone Sep 8, 2023
@psss psss self-assigned this Sep 8, 2023
@psss psss changed the title add markdown format output Add markdown format output Sep 8, 2023
@psss psss changed the title Add markdown format output Add support for markdown format output Sep 8, 2023
sandrobonazzola and others added 3 commits September 8, 2023 13:08
@sandrobonazzola @kwk @psss
add markdown format output
01ef17f 
and enable it for bugzilla, github and gitlab.

Signed-off-by: Sandro Bonazzola <[email protected]>
Co-authored-by: Konrad Kleine <[email protected]>
Co-authored-by: Petr Šplíchal <[email protected]>
@sandrobonazzola
enable markdown output for jira plugin
f01de61 
Signed-off-by: Sandro Bonazzola <[email protected]>
@sandrobonazzola
Refactor gitlab plugin
6ff8928 
addressed comment at
psss#315 (comment)

Signed-off-by: Sandro Bonazzola <[email protected]>
sandrobonazzola added a commit to sandrobonazzola/did that referenced this pull request Sep 8, 2023
@sandrobonazzola
change format selector from md to markdown
86489d3 
Adress comment at
psss#315 (comment)

Signed-off-by: Sandro Bonazzola <[email protected]>
psss
psss reviewed Sep 8, 2023
View reviewed changes
README.rst Outdated Show resolved Hide resolved
@psss
Copy link
Owner

psss commented Sep 8, 2023

One more thing: It seems that GitHub pull requests are created with url leading to issues:

did --format markdown --width 0 --github-pull-requests-created

The output looks like this:

Status report for the week 36 (2023-09-04 to 2023-09-10)

 Petr Šplíchal <[email protected]>

GitHub automatically redirects these to the proper url, so it's not that important to get fixed, but probably would be a bit nicer/cleaner. @sandrobonazzola, what do you think?

@sandrobonazzola
Copy link
Contributor Author

GitHub automatically redirects these to the proper url, so it's not that important to get fixed, but probably would be a bit nicer/cleaner. @sandrobonazzola, what do you think?

I've kind of cheated there to keep the code simpler but yes, some more parsing can be done to get avoid the redirect. I would consider doing it in another PR as enhancement when I'll have some more time to dedicate to this.

@sandrobonazzola
Copy link
Contributor Author

Nevermind, found a more useful way to do it, pushing a new commit

sandrobonazzola and others added 3 commits September 8, 2023 16:30
@sandrobonazzola @psss
change format selector from md to markdown
9226353 
Adress comment at
psss#315 (comment)

Signed-off-by: Sandro Bonazzola <[email protected]>
Co-authored-by: Petr Šplíchal <[email protected]>
@sandrobonazzola
Recognize gitlab notes properly
453f06a 
With markdown output format properly recognize notes.
Address:
https://github.com/psss/did/pull/315/files/41e93a1a4bda20c0d077258680be63363e4dcb5c#r1319684728

Signed-off-by: Sandro Bonazzola <[email protected]>
@sandrobonazzola
Fix github pull links in markdown
4984afd 
Addresses psss#315 (comment)

Signed-off-by: Sandro Bonazzola <[email protected]>
@psss
Copy link
Owner

psss commented Sep 8, 2023

Nevermind, found a more useful way to do it, pushing a new commit

Perfect, thanks!

psss
psss approved these changes Sep 8, 2023
View reviewed changes
Copy link
Owner

@psss psss left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for addressing all comments, added just a tiny adjustment in 2c505c0.

@sandrobonazzola
Copy link
Contributor Author

Thanks for addressing all comments, added just a tiny adjustment in 2c505c0.

LGTM, thanks

@psss
Copy link
Owner

psss commented Sep 8, 2023 •
edited
Loading

For some reason, the --format option is incorrectly rendered in the docs:

image

Turning off smartquotes in 273d33c should fix it.

@psss psss merged commit 9ef576c into psss:main Sep 8, 2023
15 checks passed
@sandrobonazzola sandrobonazzola deleted the markdown_output branch September 11, 2023 06:29
@psss psss mentioned this pull request Nov 10, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@psss psss psss approved these changes

@kwk kwk Awaiting requested review from kwk

Assignees

@psss psss

Labels
base enhancement plugins
Projects
None yet
Milestone
0.21
Development

Successfully merging this pull request may close these issues.
3 participants
@sandrobonazzola @psss @kwk