Skip to content

Commit

Permalink
added maintainer key to contributors
Browse files Browse the repository at this point in the history
  • Loading branch information
pirog committed Apr 4, 2024
1 parent e2d6738 commit 38b5f49
Show file tree
Hide file tree
Showing 12 changed files with 272 additions and 189 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## v1.0.0 - [April 4, 2024](https://github.com/lando/vitepress-theme-default-plus/releases/tag/v1.0.0)

## New Features

* Added `maintainer` key to `contributors`
* Updated to `[email protected]`

## v1.0.0-beta.42 - [April 2, 2024](https://github.com/lando/vitepress-theme-default-plus/releases/tag/v1.0.0-beta.42)

## New Features
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ To deploy and publish a new version of the package to the `npm` registry you nee

Note that prereleases will get pushed to the `edge` tag on the `npm` registry.

## Maintainers

* [@pirog](https://github.com/pirog)
* [@reynoldsalec](https://github.com/reynoldsalec)

## Contributors

<a href="https://github.com/lando/vitepress-theme-default-plus/graphs/contributors">
Expand Down
56 changes: 44 additions & 12 deletions components/VPLTeamMembersItem.vue
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
<template>
<article
class="VPTeamMembersItem"
:class="[size]"
:class="[size, maintainerClass]"
>
<div class="profile">
<div
v-if="member.commits && size !== 'icon'"
class="commits"
v-if="(member.commits || member.maintainer) && size !== icon"
class="top-hat"
>
{{ member.commits }}
<div class="maintainer-role">
{{ member.maintainer ? 'Maintainer' : '' }}
</div>
<div class="commits">
{{ member.commits ? member.commits : '' }}
</div>
</div>
<figure class="avatar">
<Link
Expand Down Expand Up @@ -115,6 +120,8 @@ const avatar = computed(() => {
};
});
const maintainerClass = computed(() => member.maintainer ? 'maintainer' : '');
const getLink = member => {
if (member.link) return member.link;
else if (Array.isArray(member?.links) && member.links[0]) return member.links[0].link;
Expand Down Expand Up @@ -156,6 +163,14 @@ const getAvatarTitle = member => {
background-color: transparent;
}
.VPTeamMembersItem.icon .top-hat {
display: none;
}
.VPTeamMembersItem.icon .maintainer-role {
display: none;
}
.VPTeamMembersItem.icon .commits {
display: none;
}
Expand Down Expand Up @@ -198,10 +213,6 @@ const getAvatarTitle = member => {
font-size: 12px;
}
.VPTeamMembersItem.small .commits {
top: -30px;
}
.VPTeamMembersItem.small .desc {
padding-top: 12px;
line-height: 20px;
Expand Down Expand Up @@ -252,9 +263,17 @@ const getAvatarTitle = member => {
.profile {
flex-grow: 1;
background-color: var(--vp-c-bg-soft);
background-color: var(--vpl-c-bg-contributor);
}
.maintainer .profile {
background-color: var(--vpl-c-bg-maintainer);
}
.maintainer .sp-link {
background-color: var(--vpl-c-bg-maintainer);
}
.data {
text-align: center;
}
Expand Down Expand Up @@ -293,18 +312,31 @@ const getAvatarTitle = member => {
color: var(--vp-c-text-2);
}
.commits {
.top-hat {
position: relative;
top: -30px;
display: flex;
flex-direction: row;
align-items: center;
justify-content: flex-end;
justify-content: space-between;
}
.commits {
color: var(--vp-c-text-3);
position: relative;
top: -45px;
right: -25px;
font-size: 10px
}
.maintainer-role {
color: var(--vp-c-text-3);
position: relative;
font-size: 10px;
left: -25px;
text-transform: uppercase;
font-weight: 700;
}
.org.link {
color: var(--vp-c-text-3);
transition: color 0.25s;
Expand Down
2 changes: 2 additions & 0 deletions config/landov3.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ export default function({landoPlugin, version}) {
{icon: 'twitter', link: 'https://twitter.com/pirogcommamike'},
],
sponsor: 'https://lando.dev/sponsor',
maintainer: true,
mergeOnly: true,
},
{
Expand All @@ -130,6 +131,7 @@ export default function({landoPlugin, version}) {
{icon: 'twitter', link: 'https://twitter.com/reynoldsalec'},
],
sponsor: 'https://lando.dev/sponsor',
maintainer: true,
mergeOnly: true,
},
],
Expand Down
2 changes: 2 additions & 0 deletions config/landov4.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ export default function({landoPlugin, version}) {
{icon: 'twitter', link: 'https://twitter.com/pirogcommamike'},
],
sponsor: 'https://lando.dev/sponsor',
maintainer: true,
mergeOnly: true,
},
{
Expand All @@ -130,6 +131,7 @@ export default function({landoPlugin, version}) {
{icon: 'twitter', link: 'https://twitter.com/reynoldsalec'},
],
sponsor: 'https://lando.dev/sponsor',
maintainer: true,
mergeOnly: true,
},
],
Expand Down
16 changes: 9 additions & 7 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,7 @@ export default defineConfig({
{icon: 'x', link: 'https://x.com/pirogcommamike'},
],
sponsor: 'https://lando.dev/sponsor',
mergeOnly: true,
},
{
name: 'John Ouelett',
email: '[email protected]',
title: 'Robot From Future',
maintainer: true,
mergeOnly: true,
},
{
Expand All @@ -89,6 +84,7 @@ export default defineConfig({
{icon: 'x', link: 'https://x.com/reynoldsalec'},
],
sponsor: 'https://lando.dev/sponsor',
maintainer: true,
mergeOnly: true,
},
{
Expand All @@ -102,6 +98,12 @@ export default defineConfig({
mergeOnly: true,
mergeWith: '[email protected]',
},
{
name: 'John Ouelett',
email: '[email protected]',
title: 'Robot From Future',
mergeOnly: true,
},
],
},
editLink: {pattern: 'https://github.com/lando/vitepress-theme-default-plus/edit/main/docs/:path'},
Expand Down Expand Up @@ -219,11 +221,11 @@ export default defineConfig({
{text: 'GitHub', link: 'https://github.com/lando/vitepress-theme-default-plus/issues/new/choose'},
{text: 'Slack', link: 'https://www.launchpass.com/devwithlando'},
{text: 'Contact Us', link: '/support'},
{text: 'Guides', link: '/guides'},
],
},
{text: 'Configuration', link: '/config/config'},
{text: 'Blog', link: '/blog'},
{text: 'Guides', link: '/guides'},
],
},
sidebarEnder: {
Expand Down
3 changes: 3 additions & 0 deletions docs/config/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ Once you have you should be able to use all the things below.
commits: 9999,
email: '[email protected]',
title: 'Maintainer',
maintainer: true,
mergeOnly: true,
mergeWith: '[email protected]',
org: 'Lando',
Expand All @@ -222,6 +223,8 @@ Once you have you should be able to use all the things below.

If you `debotify` it will remove any author that contains `[bot]` in their name or email.

You can `maintainer: true` to indicate a `contributor` is also a maintainer. This will bump the contributor to the top of the contributors list and have a different style.

You can `exclude` with contributors by matching _both_ their `name` and `email` using either a `string` or `object`.

You can use `include` to either _add_ new contributors or _augment_ existing ones. If you want to add additional data to a contributor pulled from the `git log` you will need to specify an `email` for it to match against.
Expand Down
1 change: 0 additions & 1 deletion docs/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,4 @@ import {VPLTeamPage, VPLTeamPageTitle, VPLTeamMembers} from '@lando/vitepress-th
import {useTeam} from '@lando/vitepress-theme-default-plus';

const members = useTeam();

</script>
Loading

0 comments on commit 38b5f49

Please sign in to comment.