Skip to content

Update reporting functionality #32

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

Merged
merged 17 commits into from
Feb 6, 2023
Merged

Update reporting functionality #32

merged 17 commits into from
Feb 6, 2023

Conversation

rogermparent
Copy link
Contributor

@rogermparent rogermparent commented Jan 27, 2023

This PR updates reporting for both the diff and whole-site link checks

The diff check has been changed to replace its deprecated send-comment syntax with current cml comment syntax

The whole site check has the Issue report functionality from dvc.org's download link checker added to it. I didn't use CML here because it seems that CML can't make Issues, only Comments or PRs.

This action also closes the report ticket if it finds all links passed.

Example report Issue at #36

@rogermparent rogermparent self-assigned this Jan 27, 2023
@rogermparent rogermparent requested a review from a team January 27, 2023 16:21
@rogermparent rogermparent changed the title Update CML syntax for link check diff report Update reporting functionality Jan 27, 2023
Comment on lines +19 to +48
owner:
description:
The owner of repository to operate on if the event doesn't include it
required: false
type: string
default: '${{ github.event.repository.owner.login }}'
repo:
description:
The repository to operate on if the event doesn't include it
required: false
type: string
default: '${{ github.event.repository.name }}'
label:
description:
The label that will be used to identify existing link-check reports to
edit
required: false
type: string
default: link-check-all
labels:
description:
The labels that will be assigned to issues created by this workflow
required: false
type: string
default: link-check-all
title:
description: The title of the issue created by this workflow
required: false
type: string
default: 'Link Checker Report'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These are from the download link checker action, mostly needed to find existing Issues

Comment on lines +1 to +3
fileIncludePatterns:
- ./test/*

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will be helpful for general testing

Comment on lines -45 to +48
run: cml send-comment --pr --update ${{ inputs.outputFile }}
run: cml comment update --watermark-title="Link Check Report" ${{ inputs.outputFile }}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated CML syntax

Comment on lines +20 to +23
config:
type: 'string'
description: 'The path to the link-check config file'
default: 'config/link-check/config.yml'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Saw this was hard-coded in this workflow while the all workflow is configurable, copied here

@rogermparent rogermparent mentioned this pull request Jan 27, 2023
Copy link
Contributor

@yathomasi yathomasi left a comment

Choose a reason for hiding this comment

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

LGTM!

@rogermparent rogermparent merged commit 1947eae into master Feb 6, 2023
rogermparent referenced this pull request in iterative/mlem.ai Feb 7, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change | Age | Adoption | Passing |
Confidence |
|---|---|---|---|---|---|---|---|
| [iterative/link-check](https://togithub.com/iterative/link-check) |
action | minor | `v0.13.2` -> `v0.14.0` |
[![age](https://badges.renovateapi.com/packages/github-tags/iterative%2flink-check/v0.14.0/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/github-tags/iterative%2flink-check/v0.14.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/github-tags/iterative%2flink-check/v0.14.0/compatibility-slim/v0.13.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/github-tags/iterative%2flink-check/v0.14.0/confidence-slim/v0.13.2)](https://docs.renovatebot.com/merge-confidence/)
|
| repo-link-check | dependencies | minor | [`^0.13.0` ->
`^0.14.0`](https://renovatebot.com/diffs/npm/repo-link-check/0.13.0/0.14.0)
|
[![age](https://badges.renovateapi.com/packages/npm/repo-link-check/0.14.0/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/repo-link-check/0.14.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/repo-link-check/0.14.0/compatibility-slim/0.13.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/repo-link-check/0.14.0/confidence-slim/0.13.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>iterative/link-check</summary>

###
[`v0.14.0`](https://togithub.com/iterative/link-check/releases/tag/v0.14.0)

[Compare
Source](https://togithub.com/iterative/link-check/compare/v0.13.2...v0.14.0)

##### What's Changed

- Update reporting functionality by
[@&#8203;rogermparent](https://togithub.com/rogermparent) in
[https://github.com/iterative/link-check/pull/32](https://togithub.com/iterative/link-check/pull/32)

**Full Changelog**:
iterative/link-check@v0.13.2...v0.14.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/iterative/mlem.ai).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMjQuMiIsInVwZGF0ZWRJblZlciI6IjM0LjEyNC4yIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants