diff --git a/docs/i18n/en/code.json b/docs/i18n/en/code.json deleted file mode 100644 index be706914..00000000 --- a/docs/i18n/en/code.json +++ /dev/null @@ -1,396 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "This page crashed.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Try again", - "description": "The label of the button to try again when the page crashed" - }, - "theme.NotFound.title": { - "message": "Page Not Found", - "description": "The title of the 404 page" - }, - "theme.NotFound.p1": { - "message": "We could not find what you were looking for.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Please contact the owner of the site that linked you to the original URL and let them know their link is broken.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.admonition.note": { - "message": "note", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "tip", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.danger": { - "message": "danger", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "info", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.caution": { - "message": "caution", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Scroll back to top", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "Archive", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Archive", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Blog list page navigation", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Newer Entries", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Older Entries", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Blog post page navigation", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Newer Post", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Older Post", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "One post|{count} posts", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} tagged with \"{tagName}\"", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "View All Tags", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Switch between dark and light mode (currently {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "dark mode", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "light mode", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.home": { - "message": "Home page", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Breadcrumbs", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} items", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Docs pages navigation", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Previous", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Next", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "One doc tagged|{count} docs tagged", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} with \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Version: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "This is unreleased documentation for {siteTitle} {versionLabel} version.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "latest version", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Edit this page", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Direct link to heading", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " on {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " by {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Last updated{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Versions", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Tags:", - "description": "The label alongside a tag list" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Close", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Blog recent posts navigation", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Copied", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Copy code to clipboard", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "Copy", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Toggle word wrap", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "Toggle the collapsible sidebar category '{label}'", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Languages", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "On this page", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "Read More", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "Read more about {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "One min read|{readingTime} min read", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Close navigation bar", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← Back to main menu", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Toggle navigation bar", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.seeAll": { - "message": "See all {count} results" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "One document found|{count} documents found", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Search results for \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Search the documentation", - "description": "The search page title for empty query" - }, - "theme.SearchPage.inputPlaceholder": { - "message": "Type your search here", - "description": "The placeholder for search page input" - }, - "theme.SearchPage.inputLabel": { - "message": "Search", - "description": "The ARIA label for search page input" - }, - "theme.SearchPage.algoliaLabel": { - "message": "Search by Algolia", - "description": "The ARIA label for Algolia mention" - }, - "theme.SearchPage.noResultsText": { - "message": "No results were found", - "description": "The paragraph for empty search result" - }, - "theme.SearchPage.fetchingNewResults": { - "message": "Fetching new results...", - "description": "The paragraph for fetching new search results" - }, - "theme.SearchBar.label": { - "message": "Search", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchModal.searchBox.resetButtonTitle": { - "message": "Clear the query", - "description": "The label and ARIA label for search box reset button" - }, - "theme.SearchModal.searchBox.cancelButtonText": { - "message": "Cancel", - "description": "The label and ARIA label for search box cancel button" - }, - "theme.SearchModal.startScreen.recentSearchesTitle": { - "message": "Recent", - "description": "The title for recent searches" - }, - "theme.SearchModal.startScreen.noRecentSearchesText": { - "message": "No recent searches", - "description": "The text when no recent searches" - }, - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { - "message": "Save this search", - "description": "The label for save recent search button" - }, - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { - "message": "Remove this search from history", - "description": "The label for remove recent search button" - }, - "theme.SearchModal.startScreen.favoriteSearchesTitle": { - "message": "Favorite", - "description": "The title for favorite searches" - }, - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { - "message": "Remove this search from favorites", - "description": "The label for remove favorite search button" - }, - "theme.SearchModal.errorScreen.titleText": { - "message": "Unable to fetch results", - "description": "The title for error screen of search modal" - }, - "theme.SearchModal.errorScreen.helpText": { - "message": "You might want to check your network connection.", - "description": "The help text for error screen of search modal" - }, - "theme.SearchModal.footer.selectText": { - "message": "to select", - "description": "The explanatory text of the action for the enter key" - }, - "theme.SearchModal.footer.selectKeyAriaLabel": { - "message": "Enter key", - "description": "The ARIA label for the Enter key button that makes the selection" - }, - "theme.SearchModal.footer.navigateText": { - "message": "to navigate", - "description": "The explanatory text of the action for the Arrow up and Arrow down key" - }, - "theme.SearchModal.footer.navigateUpKeyAriaLabel": { - "message": "Arrow up", - "description": "The ARIA label for the Arrow up key button that makes the navigation" - }, - "theme.SearchModal.footer.navigateDownKeyAriaLabel": { - "message": "Arrow down", - "description": "The ARIA label for the Arrow down key button that makes the navigation" - }, - "theme.SearchModal.footer.closeText": { - "message": "to close", - "description": "The explanatory text of the action for Escape key" - }, - "theme.SearchModal.footer.closeKeyAriaLabel": { - "message": "Escape key", - "description": "The ARIA label for the Escape key button that close the modal" - }, - "theme.SearchModal.footer.searchByText": { - "message": "Search by", - "description": "The text explain that the search is making by Algolia" - }, - "theme.SearchModal.noResultsScreen.noResultsText": { - "message": "No results for", - "description": "The text explains that there are no results for the following search" - }, - "theme.SearchModal.noResultsScreen.suggestedQueryText": { - "message": "Try searching for", - "description": "The text for the suggested query when no results are found for the following search" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsText": { - "message": "Believe this query should return results?", - "description": "The text for the question where the user thinks there are missing results" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { - "message": "Let us know.", - "description": "The text for the link to report missing results" - }, - "theme.SearchModal.placeholder": { - "message": "Search docs", - "description": "The placeholder of the input of the DocSearch pop-up modal" - }, - "theme.common.skipToMainContent": { - "message": "Skip to main content", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Tags", - "description": "The title of the tag list page" - } -} diff --git a/docs/i18n/en/docusaurus-plugin-content-docs/current.json b/docs/i18n/en/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index dd30528d..00000000 --- a/docs/i18n/en/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version.label": { - "message": "Next", - "description": "The label for version current" - } -} diff --git a/docs/i18n/en/docusaurus-theme-classic/footer.json b/docs/i18n/en/docusaurus-theme-classic/footer.json deleted file mode 100644 index 111065ba..00000000 --- a/docs/i18n/en/docusaurus-theme-classic/footer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "link.title.Pages": { - "message": "Pages", - "description": "The title of the footer links column with title=Pages in the footer" - }, - "link.title.Community": { - "message": "Community", - "description": "The title of the footer links column with title=Community in the footer" - }, - "link.title.Translations": { - "message": "Translations", - "description": "The title of the footer links column with title=Translations in the footer" - }, - "link.item.label.Installation": { - "message": "Installation", - "description": "The label of footer link with label=Installation linking to /installation/" - }, - "link.item.label.Usage": { - "message": "Usage", - "description": "The label of footer link with label=Usage linking to /usage/" - }, - "link.item.label.Donate": { - "message": "Donate", - "description": "The label of footer link with label=Donate linking to /donate/" - }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/go-task/task" - }, - "link.item.label.Twitter": { - "message": "Twitter", - "description": "The label of footer link with label=Twitter linking to https://twitter.com/taskfiledev" - }, - "link.item.label.Mastodon": { - "message": "Mastodon", - "description": "The label of footer link with label=Mastodon linking to https://fosstodon.org/@task" - }, - "link.item.label.Discord": { - "message": "Discord", - "description": "The label of footer link with label=Discord linking to https://discord.gg/6TY36E39UK" - }, - "link.item.label.OpenCollective": { - "message": "OpenCollective", - "description": "The label of footer link with label=OpenCollective linking to https://opencollective.com/task" - } -} diff --git a/docs/i18n/en/docusaurus-theme-classic/navbar.json b/docs/i18n/en/docusaurus-theme-classic/navbar.json deleted file mode 100644 index 4bab333c..00000000 --- a/docs/i18n/en/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "title": { - "message": "Task", - "description": "The title in the navbar" - }, - "item.label.Installation": { - "message": "Installation", - "description": "Navbar item with label Installation" - }, - "item.label.Usage": { - "message": "Usage", - "description": "Navbar item with label Usage" - }, - "item.label.API": { - "message": "API", - "description": "Navbar item with label API" - }, - "item.label.Donate": { - "message": "Donate", - "description": "Navbar item with label Donate" - }, - "item.label.GitHub": { - "message": "GitHub", - "description": "Navbar item with label GitHub" - }, - "item.label.Twitter": { - "message": "Twitter", - "description": "Navbar item with label Twitter" - }, - "item.label.Mastodon": { - "message": "Mastodon", - "description": "Navbar item with label Mastodon" - }, - "item.label.Discord": { - "message": "Discord", - "description": "Navbar item with label Discord" - } -} diff --git a/docs/i18n/es-ES/code.json b/docs/i18n/es-ES/code.json deleted file mode 100644 index f3d63fe5..00000000 --- a/docs/i18n/es-ES/code.json +++ /dev/null @@ -1,396 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "Ha ocurrido un error con la página.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Volver a intentarlo", - "description": "The label of the button to try again when the page crashed" - }, - "theme.NotFound.title": { - "message": "Página No Encontrada", - "description": "The title of the 404 page" - }, - "theme.NotFound.p1": { - "message": "No pudimos encontrar lo que estabas buscando.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Por favor, contacta con el propietario del sitio al que está enlazada la URL original y comunícale que el enlace está roto.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.admonition.note": { - "message": "nota", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "pista", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.danger": { - "message": "peligro", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "información", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.caution": { - "message": "precaución", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Volver arriba", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "Archivo", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Archivo", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Navegación por la página de la lista de blogs ", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Entradas más recientes", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Entradas antiguas", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Barra de paginación de publicaciones del blog", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Publicación más reciente", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Publicación más antigua", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "Una publicación|{count} publicaciones", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} etiquetados con \"{tagName}\"", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "Ver Todas las Etiquetas", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Cambiar entre modo oscuro y claro (actualmente {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "modo oscuro", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "modo claro", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.home": { - "message": "Página de inicio", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Breadcrumbs", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} items", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Navegación de páginas de documentos", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Anterior", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Siguiente", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "Un documento etiquetado|{count} documentos etiquetados", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} con \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Versión: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "Esta es documentación sin liberar para {siteTitle} {versionLabel} versión.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "Esta es documentación para {siteTitle} {versionLabel}, que ya no se mantiene activamente.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "Para la documentación actualizada, vea {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "última versión", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Editar esta página", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Enlace directo al {heading}", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " en {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " por {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Última actualización{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Versiones", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Etiquetas:", - "description": "The label alongside a tag list" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Cerrar", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Navegación de publicaciones recientes", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Copiado", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Copiar código al portapapeles", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "Copiar", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Toggle word wrap", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "Toggle the collapsible sidebar category '{label}'", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Languages", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "En esta página", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "Leer Más", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "Read more about {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "Lectura de un minuto|{readingTime} min de lectura", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Colapsar barra lateral", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Colapsar barra lateral", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Close navigation bar", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← Volver al menú principal", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Toggle navigation bar", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Expandir barra lateral", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Expandir barra lateral", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.seeAll": { - "message": "See all {count} results" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "Un documento encontrado|{count} documentos encontrados", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Resultados de búsqueda para \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Búsqueda en la documentación", - "description": "The search page title for empty query" - }, - "theme.SearchPage.inputPlaceholder": { - "message": "Escribe tu búsqueda aquí", - "description": "The placeholder for search page input" - }, - "theme.SearchPage.inputLabel": { - "message": "Buscar", - "description": "The ARIA label for search page input" - }, - "theme.SearchPage.algoliaLabel": { - "message": "Búsqueda por Algolia", - "description": "The ARIA label for Algolia mention" - }, - "theme.SearchPage.noResultsText": { - "message": "No se encontraron resultados", - "description": "The paragraph for empty search result" - }, - "theme.SearchPage.fetchingNewResults": { - "message": "Obteniendo nuevos resultados...", - "description": "The paragraph for fetching new search results" - }, - "theme.SearchBar.label": { - "message": "Buscar", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchModal.searchBox.resetButtonTitle": { - "message": "Clear the query", - "description": "The label and ARIA label for search box reset button" - }, - "theme.SearchModal.searchBox.cancelButtonText": { - "message": "Cancel", - "description": "The label and ARIA label for search box cancel button" - }, - "theme.SearchModal.startScreen.recentSearchesTitle": { - "message": "Recent", - "description": "The title for recent searches" - }, - "theme.SearchModal.startScreen.noRecentSearchesText": { - "message": "No recent searches", - "description": "The text when no recent searches" - }, - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { - "message": "Save this search", - "description": "The label for save recent search button" - }, - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { - "message": "Remove this search from history", - "description": "The label for remove recent search button" - }, - "theme.SearchModal.startScreen.favoriteSearchesTitle": { - "message": "Favorite", - "description": "The title for favorite searches" - }, - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { - "message": "Remove this search from favorites", - "description": "The label for remove favorite search button" - }, - "theme.SearchModal.errorScreen.titleText": { - "message": "Unable to fetch results", - "description": "The title for error screen of search modal" - }, - "theme.SearchModal.errorScreen.helpText": { - "message": "You might want to check your network connection.", - "description": "The help text for error screen of search modal" - }, - "theme.SearchModal.footer.selectText": { - "message": "to select", - "description": "The explanatory text of the action for the enter key" - }, - "theme.SearchModal.footer.selectKeyAriaLabel": { - "message": "Enter key", - "description": "The ARIA label for the Enter key button that makes the selection" - }, - "theme.SearchModal.footer.navigateText": { - "message": "to navigate", - "description": "The explanatory text of the action for the Arrow up and Arrow down key" - }, - "theme.SearchModal.footer.navigateUpKeyAriaLabel": { - "message": "Arrow up", - "description": "The ARIA label for the Arrow up key button that makes the navigation" - }, - "theme.SearchModal.footer.navigateDownKeyAriaLabel": { - "message": "Arrow down", - "description": "The ARIA label for the Arrow down key button that makes the navigation" - }, - "theme.SearchModal.footer.closeText": { - "message": "to close", - "description": "The explanatory text of the action for Escape key" - }, - "theme.SearchModal.footer.closeKeyAriaLabel": { - "message": "Escape key", - "description": "The ARIA label for the Escape key button that close the modal" - }, - "theme.SearchModal.footer.searchByText": { - "message": "Search by", - "description": "The text explain that the search is making by Algolia" - }, - "theme.SearchModal.noResultsScreen.noResultsText": { - "message": "No results for", - "description": "The text explains that there are no results for the following search" - }, - "theme.SearchModal.noResultsScreen.suggestedQueryText": { - "message": "Try searching for", - "description": "The text for the suggested query when no results are found for the following search" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsText": { - "message": "Believe this query should return results?", - "description": "The text for the question where the user thinks there are missing results" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { - "message": "Let us know.", - "description": "The text for the link to report missing results" - }, - "theme.SearchModal.placeholder": { - "message": "Search docs", - "description": "The placeholder of the input of the DocSearch pop-up modal" - }, - "theme.common.skipToMainContent": { - "message": "Saltar al contenido principal", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Etiquetas", - "description": "The title of the tag list page" - } -} diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md b/docs/i18n/es-ES/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md deleted file mode 100644 index 42d99117..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Introducing Experiments -description: A look at where task is, where it's going and how we're going to get there. -slug: task-in-2023 -authors: - - pd93 -tags: - - experiments - - breaking-changes - - roadmap - - v4 -image: https://i.imgur.com/mErPwqL.png -hide_table_of_contents: false ---- - -Lately, Task has been growing extremely quickly and I've found myself thinking a lot about the future of the project and how we continue to evolve and grow. I'm not much of a writer, but I think one of the things we could do better is to communicate these kinds of thoughts to the community. So, with that in mind, this is the first (hopefully of many) blog posts talking about Task and what we're up to. - - - -## :calendar: So, what have we been up to? - -Over the past 12 months or so, [@andreynering][] (Author and maintainer of the project) and I ([@pd93][]) have been working in our spare time to maintain and improve v3 of Task and we've made some amazing progress. Here are just some of the things we've released in that time: - -- An official [extension for VS Code][vscode-task]. -- Internal Tasks ([#818](https://github.com/go-task/task/pull/818)). -- Task aliases ([#879](https://github.com/go-task/task/pull/879)). -- Looping over tasks ([#1220](https://github.com/go-task/task/pull/1200)). -- A series of refactors to the core codebase to make it more maintainable and extensible. -- Loads of bug fixes and improvements. -- An integration with [Crowdin][crowdin]. Work is in progress on making our docs available in **7 new languages** (Special thanks to all our translators for the huge help with this!). -- And much, much more! :sparkles: - -We're also working on adding some really exciting and highly requested features to Task such as having the ability to run remote Taskfiles ([#1317](https://github.com/go-task/task/issues/1317)). - -None of this would have been possible without the [150 or so (and growing) contributors][contributors] to the project, numerous sponsors and a passionate community of users. Together we have more than doubled the number of GitHub stars to over 8400 :star: since the beginning of 2022 and this continues to accelerate. We can't thank you all enough for your help and support! :rocket: - -[![Star History Chart](https://api.star-history.com/svg?repos=go-task/task&type=Date)](https://star-history.com/#go-task/task&Date) - -## What's next? :thinking: - -It's extremely motivating to see so many people using and loving Task. However, in this time we've also seen an increase in the number of issues and feature requests. In particular, issues that require some kind of breaking change to Task. This isn't a bad thing, but as we grow we need to be more responsible about how we address these changes in a way that ensures stability and compatibility for existing users and their Taskfiles. - -At this point you're probably thinking something like: - -> "But you use [semantic versioning][semver] - Just release a new major version with your breaking changes." - -And you'd be right... sort of. In theory, this sounds great, but the reality is that we don't have the time to commit to a major overhaul of Task in one big bang release. This would require a colossal amount of time and coordination and with full time jobs and personal lives to tend to, this is a difficult commitment to make. Smaller, more frequent major releases are also a significant inconvenience for users as they have to constantly keep up-to-date with our breaking changes. Fortunately, there is a better way. - -## What's going to change? :monocle: - -Going forwards, breaking changes will be allowed into _minor_ versions of Task as "experimental features". To access these features users will need opt-in by enabling feature flags. This will allow us to release new features slowly and gather feedback from the community before making them the default behavior in a future major release. - -To prepare users for the next major release, we will maintain a list of [deprecated features][deprecations] and [experiments][experiments] on our docs website and publish information on how to migrate to the new behavior. - -You can read the [full breaking change proposal][breaking-change-proposal] and view all the [current experiments and their status][experiments-project] on GitHub including the [Gentle Force][gentle-force-experiment] and [Remote Taskfiles][remote-taskfiles-experiment] experiments. - -## What will happen to v2/v3 features? - -v2 has been [officially deprecated][deprecate-version-2-schema]. If you're still using a Taskfile with `version: "2"` at the top we _strongly recommend_ that you upgrade as soon as possible. Removing v2 will allow us to tidy up the codebase and focus on new functionality instead. - -When v4 is released, we will continue to support v3 for a period of time (bug fixes etc). However, since we are moving from a backward-compatibility model to a forwards-compatibility model, **v4 itself will not be backwards compatible with v3**. - -## v4 When? :eyes: - -:man_shrugging: When it's ready. - -In all seriousness, we don't have a timeline for this yet. We'll be working on the most serious deficiencies of the v3 API first and regularly evaluating the state of the project. When we feel its in a good, stable place and we have a clear upgrade path for users and a number of stable experiments, we'll start to think about v4. - -## :wave: Final thoughts - -Task is growing fast and we're excited to see where it goes next. We hope that the steps we're taking to improve the project and our process will help us to continue to grow. As always, if you have any questions or feedback, we encourage you to comment on or open [issues][issues] and [discussions][discussions] on GitHub. Alternatively, you can join us on [Discord][discord]. - -I plan to write more of these blog posts in the future on a variety of Task-related topics, so make sure to check in occasionally and see what we're up to! - - - - -[vscode-task]: https://github.com/go-task/vscode-task -[crowdin]: https://crowdin.com -[contributors]: https://github.com/go-task/task/graphs/contributors -[semver]: https://semver.org -[breaking-change-proposal]: https://github.com/go-task/task/discussions/1191 -[@andreynering]: https://github.com/andreynering -[@pd93]: https://github.com/pd93 -[experiments]: https://taskfile.dev/experiments -[deprecations]: https://taskfile.dev/deprecations -[deprecate-version-2-schema]: https://github.com/go-task/task/issues/1197 -[issues]: https://github.com/go-task/task/issues -[discussions]: https://github.com/go-task/task/discussions -[discord]: https://discord.gg/6TY36E39UK -[experiments-project]: https://github.com/orgs/go-task/projects/1 -[gentle-force-experiment]: https://github.com/go-task/task/issues/1200 -[remote-taskfiles-experiment]: https://github.com/go-task/task/issues/1317 diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-blog/authors.yml b/docs/i18n/es-ES/docusaurus-plugin-content-blog/authors.yml deleted file mode 100644 index b607ea56..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-blog/authors.yml +++ /dev/null @@ -1,10 +0,0 @@ -andreynering: - name: Andrey Nering - title: Maintainer of Task - url: https://github.com/andreynering - image_url: https://github.com/andreynering.png -pd93: - name: Pete Davison - title: Maintainer of Task - url: https://github.com/pd93 - image_url: https://github.com/pd93.png diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current.json b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index 2e8b6834..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version.label": { - "message": "Siguiente", - "description": "The label for version current" - } -} diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/api_reference.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/api_reference.md deleted file mode 100644 index ef34badb..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/api_reference.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -slug: /api/ -sidebar_position: 4 -toc_min_heading_level: 2 -toc_max_heading_level: 5 ---- - -# API Reference - -## CLI - -Task command line tool has the following syntax: - -```bash -task [--flags] [tasks...] [-- CLI_ARGS...] -``` - -:::tip - -If `--` is given, all remaining arguments will be assigned to a special `CLI_ARGS` variable - -::: - -| Short | Flag | Type | Default | Description | -| ----- | --------------------------- | -------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-c` | `--color` | `bool` | `true` | Colored output. Enabled by default. Set flag to `false` or use `NO_COLOR=1` to disable. | -| `-C` | `--concurrency` | `int` | `0` | Limit number tasks to run concurrently. Zero means unlimited. | -| `-d` | `--dir` | `string` | Working directory | Sets directory of execution. | -| `-n` | `--dry` | `bool` | `false` | Compiles and prints tasks in the order that they would be run, without executing them. | -| `-x` | `--exit-code` | `bool` | `false` | Pass-through the exit code of the task command. | -| `-f` | `--force` | `bool` | `false` | Forces execution even when the task is up-to-date. | -| `-g` | `--global` | `bool` | `false` | Runs global Taskfile, from `$HOME/Taskfile.{yml,yaml}`. | -| `-h` | `--help` | `bool` | `false` | Shows Task usage. | -| `-i` | `--init` | `bool` | `false` | Creates a new Taskfile.yml in the current folder. | -| `-I` | `--interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `-l` | `--list` | `bool` | `false` | Lists tasks with description of current Taskfile. | -| `-a` | `--list-all` | `bool` | `false` | Lists tasks with or without a description. | -| | `--sort` | `string` | `default` | Changes the order of the tasks when listed.
`default` - Alphanumeric with root tasks first
`alphanumeric` - Alphanumeric
`none` - No sorting (As they appear in the Taskfile) | -| | `--json` | `bool` | `false` | See [JSON Output](#json-output) | -| `-o` | `--output` | `string` | Default set in the Taskfile or `intervealed` | Sets output style: [`interleaved`/`group`/`prefixed`]. | -| | `--output-group-begin` | `string` | | Message template to print before a task's grouped output. | -| | `--output-group-end` | `string` | | Message template to print after a task's grouped output. | -| | `--output-group-error-only` | `bool` | `false` | Swallow command output on zero exit code. | -| `-p` | `--parallel` | `bool` | `false` | Executes tasks provided on command line in parallel. | -| `-s` | `--silent` | `bool` | `false` | Disables echoing. | -| `-y` | `--yes` | `bool` | `false` | Assume "yes" as answer to all prompts. | -| | `--status` | `bool` | `false` | Exits with non-zero exit code if any of the given tasks is not up-to-date. | -| | `--summary` | `bool` | `false` | Show summary about a task. | -| `-t` | `--taskfile` | `string` | `Taskfile.yml` or `Taskfile.yaml` | | -| `-v` | `--verbose` | `bool` | `false` | Enables verbose mode. | -| | `--version` | `bool` | `false` | Show Task version. | -| `-w` | `--watch` | `bool` | `false` | Enables watch of the given task. | - -## Exit Codes - -Task will sometimes exit with specific exit codes. These codes are split into three groups with the following ranges: - -- General errors (0-99) -- Taskfile errors (100-199) -- Task errors (200-299) - -A full list of the exit codes and their descriptions can be found below: - -| Code | Description | -| ---- | ------------------------------------------------------------ | -| 0 | Success | -| 1 | An unknown error occurred | -| 100 | No Taskfile was found | -| 101 | A Taskfile already exists when trying to initialize one | -| 102 | The Taskfile is invalid or cannot be parsed | -| 103 | A remote Taskfile could not be downloaded | -| 104 | A remote Taskfile was not trusted by the user | -| 105 | A remote Taskfile was could not be fetched securely | -| 106 | No cache was found for a remote Taskfile in offline mode | -| 107 | No schema version was defined in the Taskfile | -| 200 | The specified task could not be found | -| 201 | An error occurred while executing a command inside of a task | -| 202 | The user tried to invoke a task that is internal | -| 203 | There a multiple tasks with the same name or alias | -| 204 | A task was called too many times | -| 205 | A task was cancelled by the user | -| 206 | A task was not executed due to missing required variables | - -These codes can also be found in the repository in [`errors/errors.go`](https://github.com/go-task/task/blob/main/errors/errors.go). - -:::info - -When Task is run with the `-x`/`--exit-code` flag, the exit code of any failed commands will be passed through to the user instead. - -::: - -## JSON Output - -When using the `--json` flag in combination with either the `--list` or `--list-all` flags, the output will be a JSON object with the following structure: - -```json -{ - "tasks": [ - { - "name": "", - "desc": "", - "summary": "", - "up_to_date": false, - "location": { - "line": 54, - "column": 3, - "taskfile": "/path/to/Taskfile.yml" - } - } - // ... - ], - "location": "/path/to/Taskfile.yml" -} -``` - -## Special Variables - -There are some special variables that is available on the templating system: - -| Var | Description | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CLI_ARGS` | Contain all extra arguments passed after `--` when calling Task through the CLI. | -| `CLI_FORCE` | A boolean containing whether the `--force` or `--force-all` flags were set. | -| `TASK` | The name of the current task. | -| `ROOT_DIR` | The absolute path of the root Taskfile. | -| `TASKFILE_DIR` | The absolute path of the included Taskfile. | -| `USER_WORKING_DIR` | The absolute path of the directory `task` was called from. | -| `CHECKSUM` | The checksum of the files listed in `sources`. Only available within the `status` prop and if method is set to `checksum`. | -| `TIMESTAMP` | The date object of the greatest timestamp of the files listed in `sources`. Only available within the `status` prop and if method is set to `timestamp`. | -| `TASK_VERSION` | The current version of task. | -| `ITEM` | The value of the current iteration when using the `for` property. Can be changed to a different variable name using `as:`. | - -## ENV - -Some environment variables can be overridden to adjust Task behavior. - -| ENV | Default | Description | -| -------------------- | ------- | ----------------------------------------------------------------------------------------------------------------- | -| `TASK_TEMP_DIR` | `.task` | Location of the temp dir. Can relative to the project like `tmp/task` or absolute like `/tmp/.task` or `~/.task`. | -| `TASK_COLOR_RESET` | `0` | Color used for white. | -| `TASK_COLOR_BLUE` | `34` | Color used for blue. | -| `TASK_COLOR_GREEN` | `32` | Color used for green. | -| `TASK_COLOR_CYAN` | `36` | Color used for cyan. | -| `TASK_COLOR_YELLOW` | `33` | Color used for yellow. | -| `TASK_COLOR_MAGENTA` | `35` | Color used for magenta. | -| `TASK_COLOR_RED` | `31` | Color used for red. | -| `FORCE_COLOR` | | Force color output usage. | - -## Taskfile Schema - -| Attribute | Type | Default | Description | -| ---------- | ---------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `version` | `string` | | Version of the Taskfile. The current version is `3`. | -| `output` | `string` | `interleaved` | Output mode. Available options: `interleaved`, `group` and `prefixed`. | -| `method` | `string` | `checksum` | Default method in this Taskfile. Can be overridden in a task by task basis. Available options: `checksum`, `timestamp` and `none`. | -| `includes` | [`map[string]Include`](#include) | | Additional Taskfiles to be included. | -| `vars` | [`map[string]Variable`](#variable) | | A set of global variables. | -| `env` | [`map[string]Variable`](#variable) | | A set of global environment variables. | -| `tasks` | [`map[string]Task`](#task) | | A set of task definitions. | -| `silent` | `bool` | `false` | Default 'silent' options for this Taskfile. If `false`, can be overridden with `true` in a task by task basis. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `run` | `string` | `always` | Default 'run' option for this Taskfile. Available options: `always`, `once` and `when_changed`. | -| `interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -### Include - -| Attribute | Type | Default | Description | -| ---------- | --------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `taskfile` | `string` | | The path for the Taskfile or directory to be included. If a directory, Task will look for files named `Taskfile.yml` or `Taskfile.yaml` inside that directory. If a relative path, resolved relative to the directory containing the including Taskfile. | -| `dir` | `string` | The parent Taskfile directory | The working directory of the included tasks when run. | -| `optional` | `bool` | `false` | If `true`, no errors will be thrown if the specified file does not exist. | -| `internal` | `bool` | `false` | Stops any task in the included Taskfile from being callable on the command line. These commands will also be omitted from the output when used with `--list`. | -| `aliases` | `[]string` | | Alternative names for the namespace of the included Taskfile. | -| `vars` | `map[string]Variable` | | A set of variables to apply to the included Taskfile. | - -:::info - -Informing only a string like below is equivalent to setting that value to the `taskfile` attribute. - -```yaml -includes: - foo: ./path -``` - -::: - -### Variable - -| Attribute | Type | Default | Description | -| --------- | -------- | ------- | ------------------------------------------------------------------------ | -| _itself_ | `string` | | A static value that will be set to the variable. | -| `sh` | `string` | | A shell command. The output (`STDOUT`) will be assigned to the variable. | - -:::info - -Static and dynamic variables have different syntaxes, like below: - -```yaml -vars: - STATIC: static - DYNAMIC: - sh: echo "dynamic" -``` - -::: - -### Task - -| Attribute | Type | Default | Description | -| --------------- | ---------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmds` | [`[]Command`](#command) | | A list of shell commands to be executed. | -| `deps` | [`[]Dependency`](#dependency) | | A list of dependencies of this task. Tasks defined here will run in parallel before this task. | -| `label` | `string` | | Overrides the name of the task in the output when a task is run. Supports variables. | -| `desc` | `string` | | A short description of the task. This is displayed when calling `task --list`. | -| `prompt` | `string` | | A prompt that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks. | -| `summary` | `string` | | A longer description of the task. This is displayed when calling `task --summary [task]`. | -| `aliases` | `[]string` | | A list of alternative names by which the task can be called. | -| `sources` | `[]string` | | A list of sources to check before running this task. Relevant for `checksum` and `timestamp` methods. Can be file paths or star globs. | -| `generates` | `[]string` | | A list of files meant to be generated by this task. Relevant for `timestamp` method. Can be file paths or star globs. | -| `status` | `[]string` | | A list of commands to check if this task should run. The task is skipped otherwise. This overrides `method`, `sources` and `generates`. | -| `requires` | `[]string` | | A list of variables which should be set if this task is to run, if any of these variables are unset the task will error and not run. | -| `preconditions` | [`[]Precondition`](#precondition) | | A list of commands to check if this task should run. If a condition is not met, the task will error. | -| `requires` | [`Requires`](#requires) | | A list of required variables which should be set if this task is to run, if any variables listed are unset the task will error and not run. | -| `dir` | `string` | | The directory in which this task should run. Defaults to the current working directory. | -| `vars` | [`map[string]Variable`](#variable) | | A set of variables that can be used in the task. | -| `env` | [`map[string]Variable`](#variable) | | A set of environment variables that will be made available to shell commands. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. When combined with the `--list` flag, task descriptions will be hidden. | -| `interactive` | `bool` | `false` | Tells task that the command is interactive. | -| `internal` | `bool` | `false` | Stops a task from being callable on the command line. It will also be omitted from the output when used with `--list`. | -| `method` | `string` | `checksum` | Defines which method is used to check the task is up-to-date. `timestamp` will compare the timestamp of the sources and generates files. `checksum` will check the checksum (You probably want to ignore the .task folder in your .gitignore file). `none` skips any validation and always run the task. | -| `prefix` | `string` | | Defines a string to prefix the output of tasks running in parallel. Only used when the output mode is `prefixed`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing commands. | -| `run` | `string` | The one declared globally in the Taskfile or `always` | Specifies whether the task should run again or not if called more than once. Available options: `always`, `once` and `when_changed`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the task should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Task will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -These alternative syntaxes are available. They will set the given values to `cmds` and everything else will be set to their default values: - -```yaml -tasks: - foo: echo "foo" - - foobar: - - echo "foo" - - echo "bar" - - baz: - cmd: echo "baz" -``` - -::: - -#### Command - -| Attribute | Type | Default | Description | -| -------------- | ---------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmd` | `string` | | The shell command to be executed. | -| `task` | `string` | | Set this to trigger execution of another task instead of running a command. This cannot be set together with `cmd`. | -| `for` | [`For`](#for) | | Runs the command once for each given value. | -| `silent` | `bool` | `false` | Skips some output for this command. Note that STDOUT and STDERR of the commands will still be redirected. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to the referenced task. Only relevant when setting `task` instead of `cmd`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing the command. | -| `defer` | `string` | | Alternative to `cmd`, but schedules the command to be executed at the end of this task instead of immediately. This cannot be used together with `cmd`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the command should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Command will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -If given as a a string, the value will be assigned to `cmd`: - -```yaml -tasks: - foo: - cmds: - - echo "foo" - - echo "bar" -``` - -::: - -#### Dependency - -| Attribute | Type | Default | Description | -| --------- | ---------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------- | -| `task` | `string` | | The task to be execute as a dependency. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to this task. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. | - -:::tip - -If you don't want to set additional variables, it's enough to declare the dependency as a list of strings (they will be assigned to `task`): - -```yaml -tasks: - foo: - deps: [foo, bar] -``` - -::: - -#### For - -The `for` parameter can be defined as a string, a list of strings or a map. If it is defined as a string, you can give it any of the following values: - -- `source` - Will run the command for each source file defined on the task. (Glob patterns will be resolved, so `*.go` will run for every Go file that matches). - -If it is defined as a list of strings, the command will be run for each value. - -Finally, the `for` parameter can be defined as a map when you want to use a variable to define the values to loop over: - -| Attribute | Type | Default | Description | -| --------- | -------- | ---------------- | -------------------------------------------- | -| `var` | `string` | | The name of the variable to use as an input. | -| `split` | `string` | (any whitespace) | What string the variable should be split on. | -| `as` | `string` | `ITEM` | The name of the iterator variable. | - -#### Precondition - -| Attribute | Type | Default | Description | -| --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | -| `sh` | `string` | | Command to be executed. If a non-zero exit code is returned, the task errors without executing its commands. | -| `msg` | `string` | | Optional message to print if the precondition isn't met. | - -:::tip - -If you don't want to set a different message, you can declare a precondition like this and the value will be assigned to `sh`: - -```yaml -tasks: - foo: - precondition: test -f Taskfile.yml -``` - -::: - -#### Requires - -| Attribute | Type | Default | Description | -| --------- | ---------- | ------- | -------------------------------------------------------------------------------------------------- | -| `vars` | `[]string` | | List of variable or environment variable names that must be set if this task is to execute and run | diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/changelog.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/changelog.md deleted file mode 100644 index 628d35e1..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/changelog.md +++ /dev/null @@ -1,573 +0,0 @@ ---- -slug: /changelog/ -sidebar_position: 14 ---- - -# Changelog - -## v3.33.1 - 2023-12-21 - -- Added support for looping over map variables with the [Any Variables experiment](https://taskfile.dev/experiments/any_variables) enabled (#1435, #1437 by @pd93). -- Fixed a bug where dynamic variables were causing errors during fast compilation (#1435, #1437 by @pd93) - -## v3.33.0 - 2023-12-20 - -- Added [Any Variables experiment](https://taskfile.dev/experiments/any-variables) (#1415, #1421 by @pd93). -- Updated Docusaurus to v3 (#1432 by @pd93). -- Added `aliases` to `--json` flag output (#1430, #1431 by @pd93). -- Added new `CLI_FORCE` special variable containing whether the `--force` or `--force-all` flags were set (#1412, #1434 by @pd93). - -## v3.32.0 - 2023-11-29 - -- Added ability to exclude some files from `sources:` by using `exclude:` (#225, - - # 1324 by @pd93 and @andreynering). -- The [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) now prefers remote files over cached ones by default (#1317, #1345 by @pd93). -- Added `--timeout` flag to the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1345 by @pd93). -- Fix bug where dynamic `vars:` and `env:` were being executed when they should actually be skipped by `platforms:` (#1273, #1377 by @andreynering). -- Fix `schema.json` to make `silent` valid in `cmds` that use `for` (#1385, - - # 1386 by @iainvm). -- Add new `--no-status` flag to skip expensive status checks when running `task --list --json` (#1348, #1368 by @amancevice). - -## v3.31.0 - 2023-10-07 - -- Enabled the `--yes` flag for the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1344 by @pd93). -- Add ability to set `watch: true` in a task to automatically run it in watch mode (#231, #1361 by @andreynering). -- Fixed a bug on the watch mode where paths that contained `.git` (like `.github`), for example, were also being ignored (#1356 by @butuzov). -- Fixed a nil pointer error when running a Taskfile with no contents (#1341, - - # 1342 by @pd93). -- Added a new [exit code](https://taskfile.dev/api/#exit-codes) (107) for when a Taskfile does not contain a schema version (#1342 by @pd93). -- Increased limit of maximum task calls from 100 to 1000 for now, as some people have been reaching this limit organically now that we have loops. This check exists to detect recursive calls, but will be removed in favor of a better algorithm soon (#1321, #1332). -- Fixed templating on descriptions on `task --list` (#1343 by @blackjid). -- Fixed a bug where precondition errors were incorrectly being printed when task execution was aborted (#1337, #1338 by @sylv-io). - -## v3.30.1 - 2023-09-14 - -- Fixed a regression where some special variables weren't being set correctly (#1331, #1334 by @pd93). - -## v3.30.0 - 2023-09-13 - -- Prep work for Remote Taskfiles (#1316 by @pd93). -- Added the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) as a draft (#1152, #1317 by @pd93). -- Improve performance of content checksuming on `sources:` by replacing md5 with [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking change because checksums will be invalidated when upgrading to this release (#1325 by @ReillyBrogan). - -## v3.29.1 - 2023-08-26 - -- Update to Go 1.21 (bump minimum version to 1.20) (#1302 by @pd93) -- Fix a missing a line break on log when using `--watch` mode (#1285, #1297 by @FilipSolich). -- Fix `defer` on JSON Schema (#1288 by @calvinmclean and @andreynering). -- Fix bug in usage of special variables like `{{.USER_WORKING_DIR}}` in combination with `includes` (#1046, #1205, #1250, #1293, #1312, #1274 by @andarto, #1309 by @andreynering). -- Fix bug on `--status` flag. Running this flag should not have side-effects: it should not update the checksum on `.task`, only report its status (#1305, - - # 1307 by @visciang, #1313 by @andreynering). - -## v3.28.0 - 2023-07-24 - -- Added the ability to [loop over commands and tasks](https://taskfile.dev/usage/#looping-over-values) using `for` (#82, #1220 by @pd93). -- Fixed variable propagation in multi-level includes (#778, #996, #1256 by @hudclark). -- Fixed a bug where the `--exit-code` code flag was not returning the correct exit code when calling commands indirectly (#1266, #1270 by @pd93). -- Fixed a `nil` panic when a dependency was commented out or left empty (#1263 by @neomantra). - -## v3.27.1 - 2023-06-30 - -- Fix panic when a `.env` directory (not file) is present on current directory (#1244, #1245 by @pd93). - -## v3.27.0 - 2023-06-29 - -- Allow Taskfiles starting with lowercase characters (#947, #1221 by @pd93). - - e.g. `taskfile.yml`, `taskfile.yaml`, `taskfile.dist.yml` & `taskfile.dist.yaml` -- Bug fixes were made to the [npm installation method](https://taskfile.dev/installation/#npm). (#1190, by @sounisi5011). -- Added the [gentle force experiment](https://taskfile.dev/experiments/gentle-force) as a draft (#1200, #1216 by @pd93). -- Added an `--experiments` flag to allow you to see which experiments are enabled (#1242 by @pd93). -- Added ability to specify which variables are required in a task (#1203, #1204 by @benc-uk). - -## v3.26.0 - 2023-06-10 - -- Only rewrite checksum files in `.task` if the checksum has changed (#1185, - - # 1194 by @deviantintegral). -- Added [experiments documentation](https://taskfile.dev/experiments) to the website (#1198 by @pd93). -- Deprecated `version: 2` schema. This will be removed in the next major release (#1197, #1198, #1199 by @pd93). -- Added a new `prompt:` prop to set a warning prompt to be shown before running a potential dangurous task (#100, #1163 by @MaxCheetham, [Documentation](https://taskfile.dev/usage/#warning-prompts)). -- Added support for single command task syntax. With this change, it's now possible to declare just `cmd:` in a task, avoiding the more complex `cmds: []` when you have only a single command for that task (#1130, #1131 by @timdp). - -## v3.25.0 - 2023-05-22 - -- Support `silent:` when calling another tasks (#680, #1142 by @danquah). -- Improve PowerShell completion script (#1168 by @trim21). -- Add more languages to the website menu and show translation progress percentage (#1173 by @misitebao). -- Starting on this release, official binaries for FreeBSD will be available to download (#1068 by @andreynering). -- Fix some errors being unintendedly supressed (#1134 by @clintmod). -- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - - # 1149 by @pd93). -- Fix duplicate error message when a task does not exists (#1141, #1144 by @pd93). - -## v3.24.0 - 2023-04-15 - -- Fix Fish shell completion for tasks with aliases (#1113 by @patricksjackson). -- The default branch was renamed from `master` to `main` (#1049, #1048 by @pd93). -- Fix bug where "up-to-date" logs were not being omitted for silent tasks (#546, - - # 1107 by @danquah). -- Add `.hg` (Mercurial) to the list of ignored directories when using `--watch` (#1098 by @misery). -- More improvements to the release tool (#1096 by @pd93). -- Enforce [gofumpt](https://github.com/mvdan/gofumpt) linter (#1099 by @pd93) -- Add `--sort` flag for use with `--list` and `--list-all` (#946, #1105 by @pd93). -- Task now has [custom exit codes](https://taskfile.dev/api/#exit-codes) depending on the error (#1114 by @pd93). - -## v3.23.0 - 2023-03-26 - -Task now has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task) contributed by @pd93! :tada: The extension is maintained in a [new repository](https://github.com/go-task/vscode-task) under the `go-task` organization. We're looking to gather feedback from the community so please give it a go and let us know what you think via a [discussion](https://github.com/go-task/vscode-task/discussions), [issue](https://github.com/go-task/vscode-task/issues) or on our [Discord](https://discord.gg/6TY36E39UK)! - -> **NOTE:** The extension _requires_ v3.23.0 to be installed in order to work. - -- The website was integrated with [Crowdin](https://crowdin.com/project/taskfile) to allow the community to contribute with translations! [Chinese](https://taskfile.dev/zh-Hans/) is the first language available (#1057, #1058 by @misitebao). -- Added task location data to the `--json` flag output (#1056 by @pd93) -- Change the name of the file generated by `task --init` from `Taskfile.yaml` to `Taskfile.yml` (#1062 by @misitebao). -- Added new `splitArgs` template function (`{{splitArgs "foo bar 'foo bar baz'"}}`) to ensure string is split as arguments (#1040, #1059 by @dhanusaputra). -- Fix the value of `{{.CHECKSUM}}` variable in status (#1076, #1080 by @pd93). -- Fixed deep copy implementation (#1072 by @pd93) -- Created a tool to assist with releases (#1086 by @pd93). - -## v3.22.0 - 2023-03-10 - -- Add a brand new `--global` (`-g`) flag that will run a Taskfile from your `$HOME` directory. This is useful to have automation that you can run from anywhere in your system! ([Documentation](https://taskfile.dev/usage/#running-a-global-taskfile), #1029 by @andreynering). -- Add ability to set `error_only: true` on the `group` output mode. This will instruct Task to only print a command output if it returned with a non-zero exit code (#664, #1022 by @jaedle). -- Fixed bug where `.task/checksum` file was sometimes not being created when task also declares a `status:` (#840, #1035 by @harelwa, #1037 by @pd93). -- Refactored and decoupled fingerprinting from the main Task executor (#1039 by @pd93). -- Fixed deadlock issue when using `run: once` (#715, #1025 by @theunrepentantgeek). - -## v3.21.0 - 2023-02-22 - -- Added new `TASK_VERSION` special variable (#990, #1014 by @ja1code). -- Fixed a bug where tasks were sometimes incorrectly marked as internal (#1007 by @pd93). -- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) -- Added environment variable `FORCE_COLOR` support to force color output. Usefull for environments without TTY (#1003 by @automation-stack) - -## v3.20.0 - 2023-01-14 - -- Improve behavior and performance of status checking when using the `timestamp` mode (#976, #977 by @aminya). -- Performance optimizations were made for large Taskfiles (#982 by @pd93). -- Add ability to configure options for the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins (#908, #929 by @pd93, [Documentation](http://taskfile.dev/usage/#set-and-shopt)). -- Add new `platforms:` attribute to `task` and `cmd`, so it's now possible to choose in which platforms that given task or command will be run on. Possible values are operating system (GOOS), architecture (GOARCH) or a combination of the two. Example: `platforms: [linux]`, `platforms: [amd64]` or `platforms: [linux/amd64]`. Other platforms will be skipped (#978, #980 by @leaanthony). - -## v3.19.1 - 2022-12-31 - -- Small bug fix: closing `Taskfile.yml` once we're done reading it (#963, #964 by @HeCorr). -- Fixes a bug in v2 that caused a panic when using a `Taskfile_{{OS}}.yml` file (#961, #971 by @pd93). -- Fixed a bug where watch intervals set in the Taskfile were not being respected (#969, #970 by @pd93) -- Add `--json` flag (alias `-j`) with the intent to improve support for code editors and add room to other possible integrations. This is basic for now, but we plan to add more info in the near future (#936 by @davidalpert, #764). - -## v3.19.0 - 2022-12-05 - -- Installation via npm now supports [pnpm](https://pnpm.io/) as well ([go-task/go-npm#2](https://github.com/go-task/go-npm/issues/2), [go-task/go-npm#3](https://github.com/go-task/go-npm/pull/3)). -- It's now possible to run Taskfiles from subdirectories! A new `USER_WORKING_DIR` special variable was added to add even more flexibility for monorepos (#289, #920). -- Add task-level `dotenv` support (#389, #904). -- It's now possible to use global level variables on `includes` (#942, #943). -- The website got a brand new [translation to Chinese](https://task-zh.readthedocs.io/zh_CN/latest/) by [@DeronW](https://github.com/DeronW). Thanks! - -## v3.18.0 - 2022-11-12 - -- Show aliases on `task --list --silent` (`task --ls`). This means that aliases will be completed by the completion scripts (#919). -- Tasks in the root Taskfile will now be displayed first in `--list`/`--list-all` output (#806, #890). -- It's now possible to call a `default` task in an included Taskfile by using just the namespace. For example: `docs:default` is now automatically aliased to `docs` (#661, #815). - -## v3.17.0 - 2022-10-14 - -- Add a "Did you mean ...?" suggestion when a task does not exits another one with a similar name is found (#867, #880). -- Now YAML parse errors will print which Taskfile failed to parse (#885, #887). -- Add ability to set `aliases` for tasks and namespaces (#268, #340, #879). -- Improvements to Fish shell completion (#897). -- Added ability to set a different watch interval by setting `interval: '500ms'` or using the `--interval=500ms` flag (#813, #865). -- Add colored output to `--list`, `--list-all` and `--summary` flags (#845, - - # 874). -- Fix unexpected behavior where `label:` was being shown instead of the task name on `--list` (#603, #877). - -## v3.16.0 - 2022-09-29 - -- Add `npm` as new installation method: `npm i -g @go-task/cli` (#870, #871, [npm package](https://www.npmjs.com/package/@go-task/cli)). -- Add support to marking tasks and includes as internal, which will hide them from `--list` and `--list-all` (#818). - -## v3.15.2 - 2022-09-08 - -- Fix error when using variable in `env:` introduced in the previous release (#858, #866). -- Fix handling of `CLI_ARGS` (`--`) in Bash completion (#863). -- On zsh completion, add ability to replace `--list-all` with `--list` as already possible on the Bash completion (#861). - -## v3.15.0 - 2022-09-03 - -- Add new special variables `ROOT_DIR` and `TASKFILE_DIR`. This was a highly requested feature (#215, #857, [Documentation](https://taskfile.dev/api/#special-variables)). -- Follow symlinks on `sources` (#826, #831). -- Improvements and fixes to Bash completion (#835, #844). - -## v3.14.1 - 2022-08-03 - -- Always resolve relative include paths relative to the including Taskfile (#822, #823). -- Fix ZSH and PowerShell completions to consider all tasks instead of just the public ones (those with descriptions) (#803). - -## v3.14.0 - 2022-07-08 - -- Add ability to override the `.task` directory location with the `TASK_TEMP_DIR` environment variable. -- Allow to override Task colors using environment variables: `TASK_COLOR_RESET`, `TASK_COLOR_BLUE`, `TASK_COLOR_GREEN`, `TASK_COLOR_CYAN`, `TASK_COLOR_YELLOW`, `TASK_COLOR_MAGENTA` and `TASK_COLOR_RED` (#568, #792). -- Fixed bug when using the `output: group` mode where STDOUT and STDERR were being print in separated blocks instead of in the right order (#779). -- Starting on this release, ARM architecture binaries are been released to Snap as well (#795). -- i386 binaries won't be available anymore on Snap because Ubuntu removed the support for this architecture. -- Upgrade mvdan.cc/sh, which fixes a bug with associative arrays (#785, [mvdan/sh#884](https://github.com/mvdan/sh/issues/884), [mvdan/sh#893](https://github.com/mvdan/sh/pull/893)). - -## v3.13.0 - 2022-06-13 - -- Added `-n` as an alias to `--dry` (#776, #777). -- Fix behavior of interrupt (SIGINT, SIGTERM) signals. Task will now give time for the processes running to do cleanup work (#458, #479, #728, #769). -- Add new `--exit-code` (`-x`) flag that will pass-through the exit form the command being ran (#755). - -## v3.12.1 - 2022-05-10 - -- Fixed bug where, on Windows, variables were ending with `\r` because we were only removing the final `\n` but not `\r\n` (#717). - -## v3.12.0 - 2022-03-31 - -- The `--list` and `--list-all` flags can now be combined with the `--silent` flag to print the task names only, without their description (#691). -- Added support for multi-level inclusion of Taskfiles. This means that included Taskfiles can also include other Taskfiles. Before this was limited to one level (#390, #623, #656). -- Add ability to specify vars when including a Taskfile. [Check out the documentation](https://taskfile.dev/#/usage?id=vars-of-included-taskfiles) for more information (#677). - -## v3.11.0 - 2022-02-19 - -- Task now supports printing begin and end messages when using the `group` output mode, useful for grouping tasks in CI systems. [Check out the documentation](http://taskfile.dev/#/usage?id=output-syntax) for more information (#647, #651). -- Add `Taskfile.dist.yml` and `Taskfile.dist.yaml` to the supported file name list. [Check out the documentation](https://taskfile.dev/#/usage?id=supported-file-names) for more information (#498, #666). - -## v3.10.0 - 2022-01-04 - -- A new `--list-all` (alias `-a`) flag is now available. It's similar to the exiting `--list` (`-l`) but prints all tasks, even those without a description (#383, #401). -- It's now possible to schedule cleanup commands to run once a task finishes with the `defer:` keyword ([Documentation](https://taskfile.dev/#/usage?id=doing-task-cleanup-with-defer), - - # 475, #626). -- Remove long deprecated and undocumented `$` variable prefix and `^` command prefix (#642, #644, #645). -- Add support for `.yaml` extension (as an alternative to `.yml`). This was requested multiple times throughout the years. Enjoy! (#183, #184, #369, #584, - - # 621). -- Fixed error when computing a variable when the task directory do not exist yet (#481, #579). - -## v3.9.2 - 2021-12-02 - -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains a fix a for a important regression on Windows (#619, [mvdan/sh#768](https://github.com/mvdan/sh/issues/768), [mvdan/sh#769](https://github.com/mvdan/sh/pull/769)). - -## v3.9.1 - 2021-11-28 - -- Add logging in verbose mode for when a task starts and finishes (#533, #588). -- Fix an issue with preconditions and context errors (#597, #598). -- Quote each `{{.CLI_ARGS}}` argument to prevent one with spaces to become many (#613). -- Fix nil pointer when `cmd:` was left empty (#612, #614). -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains two relevant fixes: - - Fix quote of empty strings in `shellQuote` (#609, [mvdan/sh#763](https://github.com/mvdan/sh/issues/763)). - - Fix issue of wrong environment variable being picked when there's another very similar one (#586, [mvdan/sh#745](https://github.com/mvdan/sh/pull/745)). -- Install shell completions automatically when installing via Homebrew (#264, #592, [go-task/homebrew-tap#2](https://github.com/go-task/homebrew-tap/pull/2)). - -## v3.9.0 - 2021-10-02 - -- A new `shellQuote` function was added to the template system (`{{shellQuote "a string"}}`) to ensure a string is safe for use in shell ([mvdan/sh#727](https://github.com/mvdan/sh/pull/727), [mvdan/sh#737](https://github.com/mvdan/sh/pull/737), [Documentation](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)) -- In this version [mvdan.cc/sh](https://github.com/mvdan/sh) was upgraded with some small fixes and features - - The `read -p` flag is now supported (#314, [mvdan/sh#551](https://github.com/mvdan/sh/issues/551), [mvdan/sh#772](https://github.com/mvdan/sh/pull/722)) - - The `pwd -P` and `pwd -L` flags are now supported (#553, [mvdan/sh#724](https://github.com/mvdan/sh/issues/724), [mvdan/sh#728](https://github.com/mvdan/sh/pull/728)) - - The `$GID` environment variable is now correctly being set (#561, [mvdan/sh#723](https://github.com/mvdan/sh/pull/723)) - -## v3.8.0 - 2021-09-26 - -- Add `interactive: true` setting to improve support for interactive CLI apps (#217, #563). -- Fix some `nil` errors (#534, #573). -- Add ability to declare an included Taskfile as optional (#519, #552). -- Add support for including Taskfiles in the home directory by using `~` (#539, #557). - -## v3.7.3 - 2021-09-04 - -- Add official support to Apple M1 (#564, #567). -- Our [official Homebrew tap](https://github.com/go-task/homebrew-tap) will support more platforms, including Apple M1 - -## v3.7.0 - 2021-07-31 - -- Add `run:` setting to control if tasks should run multiple times or not. Available options are `always` (the default), `when_changed` (if a variable modified the task) and `once` (run only once no matter what). This is a long time requested feature. Enjoy! (#53, #359). - -## v3.6.0 - 2021-07-10 - -- Allow using both `sources:` and `status:` in the same task (#411, #427, #477). -- Small optimization and bug fix: don't compute variables if not needed for `dotenv:` (#517). - -## v3.5.0 - 2021-07-04 - -- Add support for interpolation in `dotenv:` (#433, #434, #453). - -## v3.4.3 - 2021-05-30 - -- Add support for the `NO_COLOR` environment variable. (#459, [fatih/color#137](https://github.com/fatih/color/pull/137)). -- Fix bug where sources were not considering the right directory in `--watch` mode (#484, #485). - -## v3.4.2 - 2021-04-23 - -- On watch, report which file failed to read (#472). -- Do not try to catch SIGKILL signal, which are not actually possible (#476). -- Improve version reporting when building Task from source using Go Modules (#462, #473). - -## v3.4.1 - 2021-04-17 - -- Improve error reporting when parsing YAML: in some situations where you would just see an generic error, you'll now see the actual error with more detail: the YAML line the failed to parse, for example (#467). -- A JSON Schema was published [here](https://json.schemastore.org/taskfile.json) and is automatically being used by some editors like Visual Studio Code (#135). -- Print task name before the command in the log output (#398). - -## v3.3.0 - 2021-03-20 - -- Add support for delegating CLI arguments to commands with `--` and a special `CLI_ARGS` variable (#327). -- Add a `--concurrency` (alias `-C`) flag, to limit the number of tasks that run concurrently. This is useful for heavy workloads. (#345). - -## v3.2.2 - 2021-01-12 - -- Improve performance of `--list` and `--summary` by skipping running shell variables for these flags (#332). -- Fixed a bug where an environment in a Taskfile was not always overridable by the system environment (#425). -- Fixed environment from .env files not being available as variables (#379). -- The install script is now working for ARM platforms (#428). - -## v3.2.1 - 2021-01-09 - -- Fixed some bugs and regressions regarding dynamic variables and directories (#426). -- The [slim-sprig](https://github.com/go-task/slim-sprig) package was updated with the upstream [sprig](https://github.com/Masterminds/sprig). - -## v3.2.0 - 2021-01-07 - -- Fix the `.task` directory being created in the task directory instead of the Taskfile directory (#247). -- Fix a bug where dynamic variables (those declared with `sh:`) were not running in the task directory when the task has a custom dir or it was in an included Taskfile (#384). -- The watch feature (via the `--watch` flag) got a few different bug fixes and should be more stable now (#423, #365). - -## v3.1.0 - 2021-01-03 - -- Fix a bug when the checksum up-to-date resolution is used by a task with a custom `label:` attribute (#412). -- Starting from this release, we're releasing official ARMv6 and ARM64 binaries for Linux (#375, #418). -- Task now respects the order of declaration of included Taskfiles when evaluating variables declaring by them (#393). -- `set -e` is now automatically set on every command. This was done to fix an issue where multiline string commands wouldn't really fail unless the sentence was in the last line (#403). - -## v3.0.1 - 2020-12-26 - -- Allow use as a library by moving the required packages out of the `internal` directory (#358). -- Do not error if a specified dotenv file does not exist (#378, #385). -- Fix panic when you have empty tasks in your Taskfile (#338, #362). - -## v3.0.0 - 2020-08-16 - -- On `v3`, all CLI variables will be considered global variables (#336, #341) -- Add support to `.env` like files (#324, #356). -- Add `label:` to task so you can override the task name in the logs (#321, - - # 337). -- Refactor how variables work on version 3 (#311). -- Disallow `expansions` on v3 since it has no effect. -- `Taskvars.yml` is not automatically included anymore. -- `Taskfile_{{OS}}.yml` is not automatically included anymore. -- Allow interpolation on `includes`, so you can manually include a Taskfile based on operation system, for example. -- Expose `.TASK` variable in templates with the task name (#252). -- Implement short task syntax (#194, #240). -- Added option to make included Taskfile run commands on its own directory (#260, #144) -- Taskfiles in version 1 are not supported anymore (#237). -- Added global `method:` option. With this option, you can set a default method to all tasks in a Taskfile (#246). -- Changed default method from `timestamp` to `checksum` (#246). -- New magic variables are now available when using `status:`: `.TIMESTAMP` which contains the greatest modification date from the files listed in `sources:`, and `.CHECKSUM`, which contains a checksum of all files listed in `status:`. This is useful for manual checking when using external, or even remote, artifacts when using `status:` (#216). -- We're now using [slim-sprig](https://github.com/go-task/slim-sprig) instead of [sprig](https://github.com/Masterminds/sprig), which allowed a file size reduction of about 22% (#219). -- We now use some colors on Task output to better distinguish message types - commands are green, errors are red, etc (#207). - -## v2.8.1 - 2020-05-20 - -- Fix error code for the `--help` flag (#300, #330). -- Print version to stdout instead of stderr (#299, #329). -- Supress `context` errors when using the `--watch` flag (#313, #317). -- Support templating on description (#276, #283). - -## v2.8.0 - 2019-12-07 - -- Add `--parallel` flag (alias `-p`) to run tasks given by the command line in parallel (#266). -- Fixed bug where calling the `task` CLI only informing global vars would not execute the `default` task. -- Add hability to silent all tasks by adding `silent: true` a the root of the Taskfile. - -## v2.7.1 - 2019-11-10 - -- Fix error being raised when `exit 0` was called (#251). - -## v2.7.0 - 2019-09-22 - -- Fixed panic bug when assigning a global variable (#229, #243). -- A task with `method: checksum` will now re-run if generated files are deleted (#228, #238). - -## v2.6.0 - 2019-07-21 - -- Fixed some bugs regarding minor version checks on `version:`. -- Add `preconditions:` to task (#205). -- Create directory informed on `dir:` if it doesn't exist (#209, #211). -- We now have a `--taskfile` flag (alias `-t`), which can be used to run another Taskfile (other than the default `Taskfile.yml`) (#221). -- It's now possible to install Task using Homebrew on Linux ([go-task/homebrew-tap#1](https://github.com/go-task/homebrew-tap/pull/1)). - -## v2.5.2 - 2019-05-11 - -- Reverted YAML upgrade due issues with CRLF on Windows (#201, [go-yaml/yaml#450](https://github.com/go-yaml/yaml/issues/450)). -- Allow setting global variables through the CLI (#192). - -## 2.5.1 - 2019-04-27 - -- Fixed some issues with interactive command line tools, where sometimes the output were not being shown, and similar issues (#114, #190, #200). -- Upgraded [go-yaml/yaml](https://github.com/go-yaml/yaml) from v2 to v3. - -## v2.5.0 - 2019-03-16 - -- We moved from the taskfile.org domain to the new fancy taskfile.dev domain. While stuff is being redirected, we strongly recommend to everyone that use [this install script](https://taskfile.dev/#/installation?id=install-script) to use the new taskfile.dev domain on scripts from now on. -- Fixed to the ZSH completion (#182). -- Add [`--summary` flag along with `summary:` task attribute](https://taskfile.org/#/usage?id=display-summary-of-task) (#180). - -## v2.4.0 - 2019-02-21 - -- Allow calling a task of the root Taskfile from an included Taskfile by prefixing it with `:` (#161, #172). -- Add flag to override the `output` option (#173). -- Fix bug where Task was persisting the new checksum on the disk when the Dry Mode is enabled (#166). -- Fix file timestamp issue when the file name has spaces (#176). -- Mitigating path expanding issues on Windows (#170). - -## v2.3.0 - 2019-01-02 - -- On Windows, Task can now be installed using [Scoop](https://scoop.sh/) (#152). -- Fixed issue with file/directory globing (#153). -- Added ability to globally set environment variables (#138, #159). - -## v2.2.1 - 2018-12-09 - -- This repository now uses Go Modules (#143). We'll still keep the `vendor` directory in sync for some time, though; -- Fixing a bug when the Taskfile has no tasks but includes another Taskfile (#150); -- Fix a bug when calling another task or a dependency in an included Taskfile (#151). - -## v2.2.0 - 2018-10-25 - -- Added support for [including other Taskfiles](https://taskfile.org/#/usage?id=including-other-taskfiles) (#98) - - This should be considered experimental. For now, only including local files is supported, but support for including remote Taskfiles is being discussed. If you have any feedback, please comment on #98. -- Task now have a dedicated documentation site: https://taskfile.org - - Thanks to [Docsify](https://docsify.js.org/) for making this pretty easy. To check the source code, just take a look at the [docs](https://github.com/go-task/task/tree/main/docs) directory of this repository. Contributions to the documentation is really appreciated. - -## v2.1.1 - 2018-09-17 - -- Fix suggestion to use `task --init` not being shown anymore (when a `Taskfile.yml` is not found) -- Fix error when using checksum method and no file exists for a source glob (#131) -- Fix signal handling when the `--watch` flag is given (#132) - -## v2.1.0 - 2018-08-19 - -- Add a `ignore_error` option to task and command (#123) -- Add a dry run mode (`--dry` flag) (#126) - -## v2.0.3 - 2018-06-24 - -- Expand environment variables on "dir", "sources" and "generates" (#116) -- Fix YAML merging syntax (#112) -- Add ZSH completion (#111) -- Implement new `output` option. Please check out the [documentation](https://github.com/go-task/task#output-syntax) - -## v2.0.2 - 2018-05-01 - -- Fix merging of YAML anchors (#112) - -## v2.0.1 - 2018-03-11 - -- Fixes panic on `task --list` - -## v2.0.0 - 2018-03-08 - -Version 2.0.0 is here, with a new Taskfile format. - -Please, make sure to read the [Taskfile versions](https://github.com/go-task/task/blob/main/TASKFILE_VERSIONS.md) document, since it describes in depth what changed for this version. - -- New Taskfile version 2 (#77) -- Possibility to have global variables in the `Taskfile.yml` instead of `Taskvars.yml` (#66) -- Small improvements and fixes - -## v1.4.4 - 2017-11-19 - -- Handle SIGINT and SIGTERM (#75); -- List: print message with there's no task with description; -- Expand home dir ("~" symbol) on paths (#74); -- Add Snap as an installation method; -- Move examples to its own repo; -- Watch: also walk on tasks called on on "cmds", and not only on "deps"; -- Print logs to stderr instead of stdout (#68); -- Remove deprecated `set` keyword; -- Add checksum based status check, alternative to timestamp based. - -## v1.4.3 - 2017-09-07 - -- Allow assigning variables to tasks at run time via CLI (#33) -- Added suport for multiline variables from sh (#64) -- Fixes env: remove square braces and evaluate shell (#62) -- Watch: change watch library and few fixes and improvements -- When use watching, cancel and restart long running process on file change (#59 and #60) - -## v1.4.2 - 2017-07-30 - -- Flag to set directory of execution -- Always echo command if is verbose mode -- Add silent mode to disable echoing of commands -- Fixes and improvements of variables (#56) - -## v1.4.1 - 2017-07-15 - -- Allow use of YAML for dynamic variables instead of $ prefix - - `VAR: {sh: echo Hello}` instead of `VAR: $echo Hello` -- Add `--list` (or `-l`) flag to print existing tasks -- OS specific Taskvars file (e.g. `Taskvars_windows.yml`, `Taskvars_linux.yml`, etc) -- Consider task up-to-date on equal timestamps (#49) -- Allow absolute path in generates section (#48) -- Bugfix: allow templating when calling deps (#42) -- Fix panic for invalid task in cyclic dep detection -- Better error output for dynamic variables in Taskvars.yml (#41) -- Allow template evaluation in parameters - -## v1.4.0 - 2017-07-06 - -- Cache dynamic variables -- Add verbose mode (`-v` flag) -- Support to task parameters (overriding vars) (#31) (#32) -- Print command, also when "set:" is specified (#35) -- Improve task command help text (#35) - -## v1.3.1 - 2017-06-14 - -- Fix glob not working on commands (#28) -- Add ExeExt template function -- Add `--init` flag to create a new Taskfile -- Add status option to prevent task from running (#27) -- Allow interpolation on `generates` and `sources` attributes (#26) - -## v1.3.0 - 2017-04-24 - -- Migrate from os/exec.Cmd to a native Go sh/bash interpreter - - This is a potentially breaking change if you use Windows. - - Now, `cmd` is not used anymore on Windows. Always use Bash-like syntax for your commands, even on Windows. -- Add "ToSlash" and "FromSlash" to template functions -- Use functions defined on github.com/Masterminds/sprig -- Do not redirect stdin while running variables commands -- Using `context` and `errgroup` packages (this will make other tasks to be cancelled, if one returned an error) - -## v1.2.0 - 2017-04-02 - -- More tests and Travis integration -- Watch a task (experimental) -- Possibility to call another task -- Fix "=" not being reconized in variables/environment variables -- Tasks can now have a description, and help will print them (#10) -- Task dependencies now run concurrently -- Support for a default task (#16) - -## v1.1.0 - 2017-03-08 - -- Support for YAML, TOML and JSON (#1) -- Support running command in another directory (#4) -- `--force` or `-f` flag to force execution of task even when it's up-to-date -- Detection of cyclic dependencies (#5) -- Support for variables (#6, #9, #14) -- Operation System specific commands and variables (#13) - -## v1.0.0 - 2017-02-28 - -- Add LICENSE file diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/community.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/community.md deleted file mode 100644 index c069c2be..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/community.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -slug: /community/ -sidebar_position: 9 ---- - -# Community - -Some of the work to improve the Task ecosystem is done by the community, be it installation methods or integrations with code editor. I (the author) am thankful for everyone that helps me to improve the overall experience. - -## Translations - -We use [Crowdin](https://crowdin.com/project/taskfile) to translate our document. - -## Integrations - -Many of our integrations are contributed and maintained by the community. You can view the full list of community integrations [here](/integrations#community-integrations). - -## Installation methods - -Some installation methods are maintained by third party: - -- [GitHub Actions](https://github.com/arduino/setup-task) by @arduino -- [AUR](https://aur.archlinux.org/packages/go-task-bin) by @carlsmedstad -- [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json) -- [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) -- [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/go-task/default.nix) -- [Conda](https://github.com/conda-forge/go-task-feedstock/) - -## More - -Also, thanks for all the [code contributors](https://github.com/go-task/task/graphs/contributors), [financial contributors](https://opencollective.com/task), all those who [reported bugs](https://github.com/go-task/task/issues?q=is%3Aissue) and [answered questions](https://github.com/go-task/task/discussions). - -If you know something that is missing in this document, please submit a pull request. diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/contributing.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/contributing.md deleted file mode 100644 index 57b2aa7b..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/contributing.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -slug: /contributing/ -sidebar_position: 11 ---- - -# Contributing - -Contributions to Task are very welcome, but we ask that you read this document before submitting a PR. - -:::note - -This document applies to the core [Task][task] repository _and_ [Task for Visual Studio Code][vscode-task]. - -::: - -## Before you start - -- **Check existing work** - Is there an existing PR? Are there issues discussing the feature/change you want to make? Please make sure you consider/address these discussions in your work. -- **Backwards compatibility** - Will your change break existing Taskfiles? It is much more likely that your change will merged if it backwards compatible. Is there an approach you can take that maintains this compatibility? If not, consider opening an issue first so that API changes can be discussed before you invest your time into a PR. -- **Experiments** - If there is no way to make your change backward compatible then there is a procedure to introduce breaking changes into minor versions. We call these "\[experiments\]\[experiments\]". If you're intending to work on an experiment, then please read the \[experiments workflow\]\[experiments-workflow\] document carefully and submit a proposal first. - -## 1. Setup - -- **Go** - Task is written in [Go][go]. We always support the latest two major Go versions, so make sure your version is recent enough. -- **Node.js** - [Node.js][nodejs] is used to host Task's documentation server and is required if you want to run this server locally. It is also required if you want to contribute to the Visual Studio Code extension. -- **Yarn** - [Yarn][yarn] is the Node.js package manager used by Task. - -## 2. Making changes - -- **Code style** - Try to maintain the existing code style where possible. Go code should be formatted by [`gofumpt`][gofumpt] and linted using [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be formatted and linted by [Prettier][prettier]. This style is enforced by our CI to ensure that we have a consistent style across the project. You can use the `task lint` command to lint the code locally and the `task lint:fix` command to automatically fix any issues that are found. -- **Documentation** - Ensure that you add/update any relevant documentation. See the [updating documentation](#updating-documentation) section below. -- **Tests** - Ensure that you add/update any relevant tests and that all tests are passing before submitting the PR. See the [writing tests](#writing-tests) section below. - -### Running your changes - -To run Task with working changes, you can use `go run ./cmd/task`. To run a development build of task against a test Taskfile in `testdata`, you can use `go run ./cmd/task --dir ./testdata/ `. - -To run Task for Visual Studio Code, you can open the project in VSCode and hit F5 (or whatever you debug keybind is set to). This will open a new VSCode window with the extension running. Debugging this way is recommended as it will allow you to set breakpoints and step through the code. Otherwise, you can run `task package` which will generate a `.vsix` file that can be used to manually install the extension. - -### Updating documentation - -Task uses [Docusaurus][docusaurus] to host a documentation server. The code for this is located in the core Task repository. This can be setup and run locally by using `task docs` (requires `nodejs` & `yarn`). All content is written in Markdown and is located in the `docs/docs` directory. All Markdown documents should have an 80 character line wrap limit (enforced by Prettier). - -When making a change, consider whether a change to the [Usage Guide](/usage) is necessary. This document contains descriptions and examples of how to use Task features. If you're adding a new feature, try to find an appropriate place to add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](/styleguide). - -If you added a new field, command or flag, ensure that you add it to the [API Reference](/api). New fields also need to be added to the [JSON Schema][json-schema]. The descriptions for fields in the API reference and the schema should match. - -### Writing tests - -A lot of Task's tests are held in the `task_test.go` file in the project root and this is where you'll most likely want to add new ones too. Most of these tests also have a subdirectory in the `testdata` directory where any Taskfiles/data required to run the tests are stored. - -When making a changes, consider whether new tests are required. These tests should ensure that the functionality you are adding will continue to work in the future. Existing tests may also need updating if you have changed Task's behavior. - -You may also consider adding unit tests for any new functions you have added. The unit tests should follow the Go convention of being location in a file named `*_test.go` in the same package as the code being tested. - -## 3. Committing your code - -Try to write meaningful commit messages and avoid having too many commits on the PR. Most PRs should likely have a single commit (although for bigger PRs it may be reasonable to split it in a few). Git squash and rebase is your friend! - -If you're not sure how to format your commit message, check out [Conventional Commits][conventional-commits]. This style is not enforced, but it is a good way to make your commit messages more readable and consistent. - -## 4. Submitting a PR - -- **Describe your changes** - Ensure that you provide a comprehensive description of your changes. -- **Issue/PR links** - Link any previous work such as related issues or PRs. Please describe how your changes differ to/extend this work. -- **Examples** - Add any examples or screenshots that you think are useful to demonstrate the effect of your changes. -- **Draft PRs** - If your changes are incomplete, but you would like to discuss them, open the PR as a draft and add a comment to start a discussion. Using comments rather than the PR description allows the description to be updated later while preserving any discussions. - -## FAQ - -> I want to contribute, where do I start? - -Take a look at the list of [open issues for Task][task-open-issues] or [Task for Visual Studio Code][vscode-task-open-issues]. We have a [good first issue][good-first-issue] label for simpler issues that are ideal for first time contributions. - -All kinds of contributions are welcome, whether its a typo fix or a shiny new feature. You can also contribute by upvoting/commenting on issues, helping to answer questions or contributing to other [community projects](/community). - -> I'm stuck, where can I get help? - -If you have questions, feel free to ask them in the `#help` forum channel on our [Discord server][discord-server] or open a [Discussion][discussion] on GitHub. - ---- - - - - -[task]: https://github.com/go-task/task -[vscode-task]: https://github.com/go-task/vscode-task -[go]: https://go.dev -[gofumpt]: https://github.com/mvdan/gofumpt -[golangci-lint]: https://golangci-lint.run -[prettier]: https://prettier.io -[nodejs]: https://nodejs.org/en/ -[yarn]: https://yarnpkg.com/ -[docusaurus]: https://docusaurus.io -[json-schema]: https://github.com/go-task/task/blob/main/docs/static/schema.json -[task-open-issues]: https://github.com/go-task/task/issues -[vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues -[good-first-issue]: https://github.com/go-task/task/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 -[discord-server]: https://discord.gg/6TY36E39UK -[discussion]: https://github.com/go-task/task/discussions -[conventional-commits]: https://www.conventionalcommits.org diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/deprecations/deprecations.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/deprecations/deprecations.md deleted file mode 100644 index 965b26d1..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/deprecations/deprecations.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: /deprecations/ -sidebar_position: 7 ---- - -# Deprecations - -As Task evolves, it occasionally outgrows some of its functionality. This can be because they are no longer useful, because another feature has replaced it or because of a change in the way that Task works internally. - -When this happens, we mark the functionality as deprecated. This means that it will be removed in a future version of Task. This functionality will continue to work until that time, but we strongly recommend that you do not implement this functionality in new Taskfiles and make a plan to migrate away from it as soon as possible. - -You can view a full list of active deprecations in the "Deprecations" section of the sidebar. diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/deprecations/template.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/deprecations/template.md deleted file mode 100644 index 646e45c6..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/deprecations/template.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Deprecated Feature\} (#\{Issue\}) - -:::warning - -This deprecation breaks the following functionality: - -- \{list any existing functionality that will be broken by this deprecation\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -\{Short description of the feature/behavior and why it is being deprecated\} - -\{Short explanation of any replacement features/behaviors and how users should migrate to it\} diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md deleted file mode 100644 index c45fb65d..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -slug: /deprecations/version-2-schema/ ---- - -# Version 2 Schema (#1197) - -:::warning - -This deprecation breaks the following functionality: - -- Any Taskfiles that use the version 2 schema -- `Taskvar.yml` files - -::: - -The Taskfile version 2 schema was introduced in March 2018 and replaced by version 3 in August 2019. In May 2023 [we published a deprecation notice][deprecation-notice] for the version 2 schema on the basis that the vast majority of users had already upgraded to version 3 and removing support for version 2 would allow us to tidy up the codebase and focus on new functionality instead. - -In December 2023, the final version of Task that supports the version 2 schema ([v3.33.0][v3.33.0]) was published and all legacy code was removed from Task's main branch. To use a more recent version of Task, you will need to ensure that your Taskfile uses the version 3 schema instead. A list of changes between version 2 and version 3 are available in the [Task v3 Release Notes][v3.0.0]. - - - - -[v3.0.0]: https://github.com/go-task/task/releases/tag/v3.0.0 -[v3.33.0]: https://github.com/go-task/task/releases/tag/v3.33.0 -[deprecation-notice]: https://github.com/go-task/task/issues/1197 diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/donate.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/donate.md deleted file mode 100644 index 66e60e6e..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/donate.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: /donate/ -sidebar_position: 16 ---- - -# Donate - -If you find this project useful, you can consider donating by using one of the channels listed below. - -This is just a way of saying "thank you", it won't give you any benefits like higher priority on issues or something similar. - -Companies who donate at least $50/month will be featured as a "Gold Sponsor" in the website homepage and on the GitHub repository README. Make contact with [@andreynering][] with the logo you want to be shown. Suspect businesses (gambling, casinos, etc) won't be allowed, though. - -## GitHub Sponsors - -The preferred way to donate to the maintainers is via GitHub Sponsors. Just use the following links to do your donation. We suggest a 50/50 split to each maintainer of the total amount you plan to donate to the project. - -- [@andreynering](https://github.com/sponsors/andreynering) -- [@pd93](https://github.com/sponsors/pd93) - -## Open Collective - -If you prefer [Open Collective](https://opencollective.com/task) you can donate by using these links: - -- [$2 per month](https://opencollective.com/task/contribute/backer-4034/checkout) -- [$5 per month](https://opencollective.com/task/contribute/supporter-8404/checkout) -- [$20 per month](https://opencollective.com/task/contribute/sponsor-4035/checkout) -- [$50 per month](https://opencollective.com/task/contribute/sponsor-28775/checkout) -- [Custom value - One-time donation option supported](https://opencollective.com/task/donate) - -## PayPal - -You can donate to [@andreynering][] via PayPal as well: - -- [Any value - One-time donation](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GSVDU63RKG45A¤cy_code=USD&source=url) - -## PIX (Brazil only) - -And if you're Brazilian, you can also donate to [@andreynering][] via PIX by [using this QR Code](/img/pix.png). - - - - -[@andreynering]: https://github.com/andreynering diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/any_variables.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/any_variables.md deleted file mode 100644 index cf2521c7..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/any_variables.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables (#1415) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any -time_. We strongly recommend that you do not use these features in a production -environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- Dynamically defined variables (using the `sh` keyword) - -::: - -:::info - -To enable this experiment, set the environment variable: -`TASK_X_ANY_VARIABLES=1`. Check out [our guide to enabling experiments -][enabling-experiments] for more information. - -::: - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the [slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for "collection-type" variables, the `for` -keyword has been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -This also works for maps. When looping over a map we also make an additional -`{{.KEY}}` variable availabe that holds the string value of the map key. -Remember that maps are unordered, so the order in which the items are looped -over is random: - -```yaml -version: 3 - -tasks: - foo: - vars: - MAP: - KEY_1: - SUBKEY: sub_value_1 - KEY_2: - SUBKEY: sub_value_2 - KEY_3: - SUBKEY: sub_value_3 - cmds: - - for: - var: MAP - cmd: echo {{.KEY}} {{.ITEM.SUBKEY}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[enabling-experiments]: /experiments/#enabling-experiments - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx deleted file mode 100644 index 73cdcd80..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables - -- Issue: #1415 -- Environment variable: `TASK_X_ANY_VARIABLES=1` -- Breaks: - - Dynamically defined variables (using the `sh` keyword) - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the -[slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for array variables, the `for` keyword has -been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/experiments.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/experiments.md deleted file mode 100644 index b1a70473..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/experiments.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -slug: /experiments/ -sidebar_position: 6 ---- - -# Experiments - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -In order to allow Task to evolve quickly, we roll out breaking changes to minor versions behind experimental flags. This allows us to gather feedback on breaking changes before committing to a major release. This document describes the current set of experimental features and their status in the [workflow](#workflow). - -You can view a full list of active experiments in the "Experiments" section of the sidebar. - -## Enabling Experiments - -You can enable an experimental feature by doing one of the following: - -1. Using the relevant environment variable in front of a task command. For example, `TASK_X_{FEATURE}=1 task {my-task}`. This is intended for one-off invocations of Task to test out experimental features. -1. Using the relevant environment variable in your "dotfiles" (e.g. `.bashrc`, `.zshrc` etc.). This is intended for permanently enabling experimental features in your environment. -1. Creating a `.env` file in the same directory as your root Taskfile that contains the relevant environment variables. This allows you to enable an experimental feature at a project level. For example: - -```shell title=".env" -TASK_X_FEATURE=1 -``` - -## Current Experimental Features and Deprecations - -Each section below details an experiment or deprecation and explains what the flags/environment variables to enable the experiment are and how the feature's behavior will change. It will also explain what you need to do to migrate any existing Taskfiles to the new behavior. - -## Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -### 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -### 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -### 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -### 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -### 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -### Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/gentle_force.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/gentle_force.md deleted file mode 100644 index 514602bb..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/gentle_force.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -slug: /experiments/gentle-force/ ---- - -# Gentle Force (#1200) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- The `--force` flag - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_FORCE=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -The `--force` flag currently forces _all_ tasks to run regardless of the status checks. This can be useful, but we have found that most of the time users only expect the direct task they are calling to be forced and _not_ all of its dependant tasks. - -This experiment changes the `--force` flag to only force the directly called task. All dependant tasks will have their statuses checked as normal and will only run if Task considers them to be out of date. A new `--force-all` flag will also be added to maintain the current behavior for users that need this functionality. - -If you want to migrate, but continue to force all dependant tasks to run, you should replace all uses of the `--force` flag with `--force-all`. Alternatively, if you want to adopt the new behavior, you can continue to use the `--force` flag as you do now! - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md deleted file mode 100644 index 73a934d8..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -slug: /experiments/remote-taskfiles/ ---- - -# Remote Taskfiles (#1317) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_REMOTE_TASKFILES=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -This experiment allows you to specify a remote Taskfile URL when including a Taskfile. For example: - -```yaml -version: '3' - -includes: - my-remote-namespace: https://raw.githubusercontent.com/my-org/my-repo/main/Taskfile.yml -``` - -This works exactly the same way that including a local file does. Any tasks in the remote Taskfile will be available to run from your main Taskfile via the namespace `my-remote-namespace`. For example, if the remote file contains the following: - -```yaml -version: '3' - -tasks: - hello: - silent: true - cmds: - - echo "Hello from the remote Taskfile!" -``` - -and you run `task my-remote-namespace:hello`, it will print the text: "Hello from the remote Taskfile!" to your console. - -## Security - -Running commands from sources that you do not control is always a potential security risk. For this reason, we have added some checks when using remote Taskfiles: - -1. When running a task from a remote Taskfile for the first time, Task will print a warning to the console asking you to check that you are sure that you trust the source of the Taskfile. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the remote Taskfile will run and further calls to the remote Taskfile will not prompt you again. -2. Whenever you run a remote Taskfile, Task will create and store a checksum of the file that you are running. If the checksum changes, then Task will print another warning to the console to inform you that the contents of the remote file has changed. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the checksum will be updated and the remote Taskfile will run. - -Sometimes you need to run Task in an environment that does not have an interactive terminal, so you are not able to accept a prompt. In these cases you are able to tell task to accept these prompts automatically by using the `--yes` flag. Before enabling this flag, you should: - -1. Be sure that you trust the source and contents of the remote Taskfile. -2. Consider using a pinned version of the remote Taskfile (e.g. A link containing a commit hash) to prevent Task from automatically accepting a prompt that says a remote Taskfile has changed. - -Task currently supports both `http` and `https` URLs. However, the `http` requests will not execute by default unless you run the task with the `--insecure` flag. This is to protect you from accidentally running a remote Taskfile that is hosted on and unencrypted connection. Sources that are not protected by TLS are vulnerable to [man-in-the-middle attacks][man-in-the-middle-attacks] and should be avoided unless you know what you are doing. - -## Caching & Running Offline - -Whenever you run a remote Taskfile, the latest copy will be downloaded from the internet and cached locally. If for whatever reason, you lose access to the internet, you will still be able to run your tasks by specifying the `--offline` flag. This will tell Task to use the latest cached version of the file instead of trying to download it. You are able to use the `--download` flag to update the cached version of the remote files without running any tasks. - -By default, Task will timeout requests to download remote files after 10 seconds and look for a cached copy instead. This timeout can be configured by setting the `--timeout` flag and specifying a duration. For example, `--timeout 5s` will set the timeout to 5 seconds. - - - - -[enabling-experiments]: /experiments/#enabling-experiments -[man-in-the-middle-attacks]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/template.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/template.md deleted file mode 100644 index 59246cf5..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/template.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Experiment\} (#\{Issue\}) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- \{list any existing functionality that will be broken by this experiment\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_{feature}=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -\{Short description of the feature\} - -\{Short explanation of how users should migrate to the new behavior\} - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/workflow.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/workflow.md deleted file mode 100644 index 62aff616..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/experiments/workflow.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /experiments/workflow/ ---- - -# Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -## 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -## 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -## 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -## 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -## 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -## Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/faq.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/faq.md deleted file mode 100644 index b6aa46f9..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/faq.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -slug: /faq/ -sidebar_position: 15 ---- - -# FAQ - -This page contains a list of frequently asked questions about Task. - -## Why won't my task update my shell environment? - -This is a limitation of how shells work. Task runs as a subprocess of your current shell, so it can't change the environment of the shell that started it. This limitation is shared by other task runners and build tools too. - -A common way to work around this is to create a task that will generate output that can be parsed by your shell. For example, to set an environment variable on your shell you can write a task like this: - -```yaml -my-shell-env: - cmds: - - echo "export FOO=foo" - - echo "export BAR=bar" -``` - -Now run `eval $(task my-shell-env)` and the variables `$FOO` and `$BAR` will be available in your shell. - -## I can't reuse my shell in a task's commands - -Task runs each command as a separate shell process, so something you do in one command won't effect any future commands. For example, this won't work: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - a=foo - - echo $a - # outputs "" -``` - -To work around this you can either use a multiline command: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - | - a=foo - echo $a - # outputs "foo" -``` - -Or for more complex multi-line commands it is recommended to move your code into a separate file and call that instead: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - ./foo-printer.bash -``` - -```bash -#!/bin/bash -a=foo -echo $a -``` - -## 'x' builtin command doesn't work on Windows - -The default shell on Windows (`cmd` and `powershell`) do not have commands like `rm` and `cp` available as builtins. This means that these commands won't work. If you want to make your Taskfile fully cross-platform, you'll need to work around this limitation using one of the following methods: - -- Use the `{{OS}}` function to run an OS-specific script. -- Use something like `{{if eq OS "windows"}}powershell {{end}}` to detect windows and run the command in Powershell directly. -- Use a shell on Windows that supports these commands as builtins, such as [Git Bash][git-bash] or [WSL][wsl]. - -We want to make improvements to this part of Task and the issues below track this work. Constructive comments and contributions are very welcome! - -- #197 -- [mvdan/sh#93](https://github.com/mvdan/sh/issues/93) -- [mvdan/sh#97](https://github.com/mvdan/sh/issues/97) - - - - -[git-bash]: https://gitforwindows.org/ -[wsl]: https://learn.microsoft.com/en-us/windows/wsl/install diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/installation.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/installation.md deleted file mode 100644 index 5b4d48eb..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/installation.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -slug: /installation/ -sidebar_position: 2 ---- - -# Installation - -Task offers many installation methods. Check out the available methods below. - -## Package Managers - -### Homebrew - -If you're on macOS or Linux and have [Homebrew][homebrew] installed, getting Task is as simple as running: - -```bash -brew install go-task/tap/go-task -``` - -The above Formula is [maintained by ourselves](https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb). - -Recently, Task was also made available [on the official Homebrew repository](https://formulae.brew.sh/formula/go-task), so you also have that option if you prefer: - -```bash -brew install go-task -``` - -### Tea - -If you're on macOS or Linux and have [tea][tea] installed, getting Task is as simple as running: - -```bash -tea task -``` - -or, if you have tea’s magic enabled: - -```bash -task -``` -This installation method is community owned. After a new release of Task, they are automatically released by tea in a minimum of time. - -### Snap - -Task is available in [Snapcraft][snapcraft], but keep in mind that your Linux distribution should allow classic confinement for Snaps to Task work right: - -```bash -sudo snap install task --classic -``` - -### Chocolatey - -If you're on Windows and have [Chocolatey][choco] installed, getting Task is as simple as running: - -```bash -choco install go-task -``` - -This installation method is community owned. - -### Scoop - -If you're on Windows and have [Scoop][scoop] installed, getting Task is as simple as running: - -```cmd -scoop install task -``` - -This installation method is community owned. After a new release of Task, it may take some time until it's available on Scoop. - -### AUR - -If you're on Arch Linux you can install Task from [AUR](https://aur.archlinux.org/packages/go-task-bin) using your favorite package manager such as `yay`, `pacaur` or `yaourt`: - -```cmd -yay -S go-task-bin -``` - -Alternatively, there's [this package](https://aur.archlinux.org/packages/go-task) which installs from the source code instead of downloading the binary from the [releases page](https://github.com/go-task/task/releases): - -```cmd -yay -S go-task -``` - -This installation method is community owned. - -### Fedora - -If you're on Fedora Linux you can install Task from the official [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) repository using `dnf`: - -```cmd -sudo dnf install go-task -``` - -This installation method is community owned. After a new release of Task, it may take some time until it's available in [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/). - -### Nix - -If you're on NixOS or have Nix installed you can install Task from [nixpkgs](https://github.com/NixOS/nixpkgs): - -```cmd -nix-env -iA nixpkgs.go-task -``` - -This installation method is community owned. After a new release of Task, it may take some time until it's available in [nixpkgs](https://github.com/NixOS/nixpkgs). - -### npm - -You can also use Node and npm to install Task by installing [this package](https://www.npmjs.com/package/@go-task/cli). - -```bash -npm install -g @go-task/cli -``` - -### Winget - -If you are using Windows and installed the [winget](https://github.com/microsoft/winget-cli) package management tool, you can install Task from [winget-pkgs](https://github.com/microsoft/winget-pkgs). - -```bash -winget install Task.Task -``` - -## Get The Binary - -### Binary - -You can download the binary from the [releases page on GitHub][releases] and add to your `$PATH`. - -DEB and RPM packages are also available. - -The `task_checksums.txt` file contains the SHA-256 checksum for each file. - -### Install Script - -We also have an [install script][installscript] which is very useful in scenarios like CI. Many thanks to [GoDownloader][godownloader] for enabling the easy generation of this script. - -By default, it installs on the `./bin` directory relative to the working directory: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -``` - -It is possible to override the installation directory with the `-b` parameter. On Linux, common choices are `~/.local/bin` and `~/bin` to install for the current user or `/usr/local/bin` to install for all users: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin -``` - -:::caution - -On macOS and Windows, `~/.local/bin` and `~/bin` are not added to `$PATH` by default. - -::: - -### GitHub Actions - -If you want to install Task in GitHub Actions you can try using [this action](https://github.com/arduino/setup-task) by the Arduino team: - -```yaml -- name: Install Task - uses: arduino/setup-task@v1 - with: - version: 3.x - repo-token: ${{ secrets.GITHUB_TOKEN }} -``` - -This installation method is community owned. - -## Build From Source - -### Go Modules - -Ensure that you have a supported version of [Go][go] properly installed and setup. You can find the minimum required version of Go in the [go.mod](https://github.com/go-task/task/blob/main/go.mod#L3) file. - -You can then install the latest release globally by running: - -```bash -go install github.com/go-task/task/v3/cmd/task@latest -``` - -Or you can install into another directory: - -```bash -env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest -``` - -:::tip - -For CI environments we recommend using the [install script](#install-script) instead, which is faster and more stable, since it'll just download the latest released binary. - -::: - -## Setup completions - -Download the autocompletion file corresponding to your shell. - -[All completions are available on the Task repository](https://github.com/go-task/task/tree/main/completion). - -### Bash - -First, ensure that you installed bash-completion using your package manager. - -Make the completion file executable: - -``` -chmod +x path/to/task.bash -``` - -After, add this to your `~/.bash_profile`: - -```shell -source path/to/task.bash -``` - -### ZSH - -Put the `_task` file somewhere in your `$FPATH`: - -```shell -mv path/to/_task /usr/local/share/zsh/site-functions/_task -``` - -Ensure that the following is present in your `~/.zshrc`: - -```shell -autoload -U compinit -compinit -i -``` - -ZSH version 5.7 or later is recommended. - -### Fish - -Move the `task.fish` completion script: - -```shell -mv path/to/task.fish ~/.config/fish/completions/task.fish -``` - -### PowerShell - -Open your profile script with: - -``` -mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue -notepad $profile -``` - -Add the line and save the file: - -```shell -Invoke-Expression -Command path/to/task.ps1 -``` - - - - -[go]: https://golang.org/ -[snapcraft]: https://snapcraft.io/task -[homebrew]: https://brew.sh/ -[installscript]: https://github.com/go-task/task/blob/main/install-task.sh -[releases]: https://github.com/go-task/task/releases -[godownloader]: https://github.com/goreleaser/godownloader -[choco]: https://chocolatey.org/ -[scoop]: https://scoop.sh/ -[tea]: https://tea.xyz/ diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/integrations.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/integrations.md deleted file mode 100644 index 873da703..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/integrations.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -slug: /integrations/ -sidebar_position: 8 ---- - -# Integrations - -## Visual Studio Code Extension - -Task has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task). El código de ese proyecto puede ser encontrado [aquí](https://github.com/go-task/vscode-task). Para usar la extensión es necesario tener instalada la versión v3.23.0+ de Task. - -La extensión proporciona las siguientes funcionalidades (y más...): - -- View tasks in the sidebar. -- Ejecuta tareas desde la barra lateral y la paleta de comandos. -- Go to definition from the sidebar and command palette. -- Run last task command. -- Multi-root workspace support. -- Initialize a Taskfile in the current workspace. - -To get autocompletion and validation for your Taskfile, see the [Schema](#schema) section below. - -![Task for Visual Studio Code](https://github.com/go-task/vscode-task/blob/main/res/preview.png?raw=true) - -## Schema - -This was initially created by @KROSF in [this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and is now officially maintained in [this file](https://github.com/go-task/task/blob/main/docs/static/schema.json) and made available at https://taskfile.dev/schema.json. This schema can be used to validate Taskfiles and provide autocompletion in many code editors: - -### Visual Studio Code - -To integrate the schema into VS Code, you need to install the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) by Red Hat. Any `Taskfile.yml` in your project should automatically be detected and validation/autocompletion should work. If this doesn't work or you want to manually configure it for files with a different name, you can add the following to your `settings.json`: - -```json -// settings.json -{ - "yaml.schemas": { - "https://taskfile.dev/schema.json": [ - "**/Taskfile.yml", - "./path/to/any/other/taskfile.yml" - ] - } -} -``` - -You can also configure the schema directly inside of a Taskfile by adding the following comment to the top of the file: - -```yaml -# yaml-language-server: $schema=https://taskfile.dev/schema.json -version: '3' -``` - -You can find more information on this in the [YAML language server project](https://github.com/redhat-developer/yaml-language-server). - -## Community Integrations - -In addition to our official integrations, there is an amazing community of developers who have created their own integrations for Task: - -- [Sublime Text Plugin](https://packagecontrol.io/packages/Taskfile) [[source](https://github.com/biozz/sublime-taskfile)] by @biozz -- [IntelliJ Plugin](https://plugins.jetbrains.com/plugin/17058-taskfile) [[source](https://github.com/lechuckroh/task-intellij-plugin)] by @lechuckroh -- [mk](https://github.com/pycontribs/mk) command line tool recognizes Taskfiles natively. - -If you have made something that integrates with Task, please feel free to open a PR to add it to this list. diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/intro.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/intro.md deleted file mode 100644 index c06c1cf3..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/intro.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -slug: / -sidebar_position: 1 -title: Home ---- - -# Task - -
- -
- -Task is a task runner / build tool that aims to be simpler and easier to use than, for example, [GNU Make][make]. - -Since it's written in [Go][go], Task is just a single binary and has no other dependencies, which means you don't need to mess with any complicated install setups just to use a build tool. - -Once [installed](/installation), you just need to describe your build tasks using a simple [YAML][yaml] schema in a file called `Taskfile.yml`: - -```yaml title="Taskfile.yml" -version: '3' - -tasks: - hello: - cmds: - - echo 'Hello World from Task!' - silent: true -``` - -And call it by running `task hello` from your terminal. - -The above example is just the start, you can take a look at the [usage](/usage) guide to check the full schema documentation and Task features. - -## Features - -- [Easy installation](/installation): just download a single binary, add to `$PATH` and you're done! Or you can also install using [Homebrew][homebrew], [Snapcraft][snapcraft], or [Scoop][scoop] if you want. -- Available on CIs: by adding [this simple command](/installation#install-script) to install on your CI script and you're ready to use Task as part of your CI pipeline; -- Truly cross-platform: while most build tools only work well on Linux or macOS, Task also supports Windows thanks to [this shell interpreter for Go][sh]. -- Great for code generation: you can easily [prevent a task from running](/usage#prevent-unnecessary-work) if a given set of files haven't changed since last run (based either on its timestamp or content). - - - - -[make]: https://www.gnu.org/software/make/ -[go]: https://go.dev/ -[yaml]: http://yaml.org/ -[homebrew]: https://brew.sh/ -[snapcraft]: https://snapcraft.io/ -[scoop]: https://scoop.sh/ -[sh]: https://github.com/mvdan/sh diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/releasing.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/releasing.md deleted file mode 100644 index b232b322..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/releasing.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /releasing/ -sidebar_position: 13 ---- - -# Releasing - -The release process of Task is done with the help of [GoReleaser][goreleaser]. You can test the release process locally by calling the `test-release` task of the Taskfile. - -[GitHub Actions](https://github.com/go-task/task/actions) should release artifacts automatically when a new Git tag is pushed to `main` branch (raw executables and DEB and RPM packages). - -Since v3.15.0, raw executables can also be reproduced and verified locally by checking out a specific tag and calling `goreleaser build`, using the Go version defined in the above GitHub Actions. - -# Homebrew - -Goreleaser will automatically push a new commit to the [Formula/go-task.rb][gotaskrb] file in the [Homebrew tap][homebrewtap] repository to release the new version. - -# npm - -To release to npm update the version in the [`package.json`][packagejson] file and then run `task npm:publish` to push it. - -# Snapcraft - -The [snap package][snappackage] requires to manual steps to release a new version: - -- Updating the current version on [snapcraft.yaml][snapcraftyaml]. -- Moving both `amd64`, `armhf` and `arm64` new artifacts to the stable channel on the [Snapcraft dashboard][snapcraftdashboard]. - -# winget - -winget also requires manual steps to be completed. By running `task goreleaser:test` locally, manifest files will be generated on `dist/winget/manifests/t/Task/Task/v{version}`. [Upload the manifest directory into this fork](https://github.com/go-task/winget-pkgs/tree/master/manifests/t/Task/Task) and open a pull request into [this repository](https://github.com/microsoft/winget-pkgs). - -# Scoop - -Scoop is a command-line package manager for the Windows operating system. Scoop package manifests are maintained by the community. Scoop owners usually take care of updating versions there by editing [this file](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json). If you think its Task version is outdated, open an issue to let us know. - -# Nix - -Nix is a community owned installation method. Nix package maintainers usually take care of updating versions there by editing [this file](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/development/tools/go-task/default.nix). If you think its Task version is outdated, open an issue to let us know. - - - - -[goreleaser]: https://goreleaser.com/ -[homebrewtap]: https://github.com/go-task/homebrew-tap -[gotaskrb]: https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb -[packagejson]: https://github.com/go-task/task/blob/main/package.json#L3 -[snappackage]: https://github.com/go-task/snap -[snapcraftyaml]: https://github.com/go-task/snap/blob/main/snap/snapcraft.yaml#L2 -[snapcraftdashboard]: https://snapcraft.io/task/releases diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/styleguide.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/styleguide.md deleted file mode 100644 index 753477a4..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/styleguide.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -slug: /styleguide/ -sidebar_position: 10 ---- - -# Styleguide - -This is the official Task styleguide for `Taskfile.yml` files. This guide contains some basic instructions to keep your Taskfile clean and familiar to other users. - -This contains general guidelines, but they don't necessarily need to be strictly followed. Feel free to disagree and proceed differently at some point if you need or want to. Also, feel free to open issues or pull requests with improvements to this guide. - -## Use the correct order of keywords - -- `version:` -- `includes:` -- Configuration ones, like `output:`, `silent:`, `method:` and `run:` -- `vars:` -- `env:`, `dotenv:` -- `tasks:` - -## Use 2 spaces for indentation - -This is the most common convention for YAML files, and Task follows it. - -```yaml -# bad -tasks: - foo: - cmds: - - echo 'foo' - - -# good -tasks: - foo: - cmds: - - echo 'foo' -``` - -## Separate with spaces the mains sections - -```yaml -# bad -version: '3' -includes: - docker: ./docker/Taskfile.yml -output: prefixed -vars: - FOO: bar -env: - BAR: baz -tasks: - # ... - - -# good -version: '3' - -includes: - docker: ./docker/Taskfile.yml - -output: prefixed - -vars: - FOO: bar - -env: - BAR: baz - -tasks: - # ... -``` - -## Add spaces between tasks - -```yaml -# bad -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - bar: - cmds: - - echo 'bar' - baz: - cmds: - - echo 'baz' - - -# good -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - - bar: - cmds: - - echo 'bar' - - baz: - cmds: - - echo 'baz' -``` - -## Use upper-case variable names - -```yaml -# bad -version: '3' - -vars: - binary_name: myapp - -tasks: - build: - cmds: - - go build -o {{.binary_name}} . - - -# good -version: '3' - -vars: - BINARY_NAME: myapp - -tasks: - build: - cmds: - - go build -o {{.BINARY_NAME}} . -``` - -## Don't wrap vars in spaces when templating - -```yaml -# bad -version: '3' - -tasks: - greet: - cmds: - - echo '{{ .MESSAGE }}' - - -# good -version: '3' - -tasks: - greet: - cmds: - - echo '{{.MESSAGE}}' -``` - -This convention is also used by most people for any Go templating. - -## Separate task name words with a dash - -```yaml -# bad -version: '3' - -tasks: - do_something_fancy: - cmds: - - echo 'Do something' - - -# good -version: '3' - -tasks: - do-something-fancy: - cmds: - - echo 'Do something' -``` - -## Use colon for task namespacing - -```yaml -# good -version: '3' - -tasks: - docker:build: - cmds: - - docker ... - - docker:run: - cmds: - - docker-compose ... -``` - -This is also done automatically when using included Taskfiles. - -## Prefer external scripts over complex multi-line commands - -```yaml -# bad -version: '3' - -tasks: - build: - cmds: - - | - for i in $(seq 1 10); do - echo $i - echo "some other complex logic" - done' - -# good -version: '3' - -tasks: - build: - cmds: - - ./scripts/my_complex_script.sh -``` diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/taskfile_versions.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/taskfile_versions.md deleted file mode 100644 index aaa1ab71..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/taskfile_versions.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -slug: /taskfile-versions/ -sidebar_position: 5 ---- - -# Taskfile Versions - -The Taskfile syntax and features changed with time. This document explains what changed on each version and how to upgrade your Taskfile. - -## What the Taskfile version mean - -The Taskfile version follows the Task version. E.g. the change to Taskfile version `2` means that Task `v2.0.0` should be release to support it. - -The `version:` key on Taskfile accepts a semver string, so either `2`, `2.0` or `2.0.0` is accepted. If you choose to use `2.0` Task will not enable future `2.1` features, but if you choose to use `2`, then any `2.x.x` features will be available, but not `3.0.0+`. - -## Version 3 ![latest](https://img.shields.io/badge/latest-brightgreen) - -These are some major changes done on `v3`: - -- Task's output will now be colored -- Added support for `.env` like files -- Added `label:` setting to task so one can override how the task name appear in the logs -- A global `method:` was added to allow setting the default method, and Task's default changed to `checksum` -- Two magic variables were added when using `status:`: `CHECKSUM` and `TIMESTAMP` which contains, respectively, the XXH3 checksum and greatest modification timestamp of the files listed on `sources:` -- Also, the `TASK` variable is always available with the current task name -- CLI variables are always treated as global variables -- Added `dir:` option to `includes` to allow choosing on which directory an included Taskfile will run: - -```yaml -includes: - docs: - taskfile: ./docs - dir: ./docs -``` - -- Implemented short task syntax. All below syntaxes are equivalent: - -```yaml -version: '3' - -tasks: - print: - cmds: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: echo "Hello, World!" -``` - -- There was a major refactor on how variables are handled. They're now easier to understand. The `expansions:` setting was removed as it became unnecessary. This is the order in which Task will process variables, each level can see the variables set by the previous one and override those. - - Environment variables - - Global + CLI variables - - Call variables - - Task variables - -## Version 2.6 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.6 comes with `preconditions` stanza in tasks. - -```yaml -version: '2' - -tasks: - upload_environment: - preconditions: - - test -f .env - cmds: - - aws s3 cp .env s3://myenvironment -``` - -Please check the [documentation][includes] - -## Version 2.2 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.2 comes with a global `includes` options to include other Taskfiles: - -```yaml -version: '2' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -## Version 2.1 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.1 includes a global `output` option, to allow having more control over how commands output are printed to the console (see [documentation][output] for more info): - -```yaml -version: '2' - -output: prefixed - -tasks: - server: - cmds: - - go run main.go - prefix: server -``` - -From this version it's also possible to ignore errors of a command or task (check documentation [here][ignore_errors]): - -```yaml -version: '2' - -tasks: - example-1: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "This will be print" - - example-2: - cmds: - - exit 1 - - echo "This will be print" - ignore_error: true -``` - -## Version 2.0 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -At version 2, we introduced the `version:` key, to allow us to evolve Task with new features without breaking existing Taskfiles. The new syntax is as follows: - -```yaml -version: '2' - -tasks: - echo: - cmds: - - echo "Hello, World!" -``` - -Version 2 allows you to write global variables directly in the Taskfile, if you don't want to create a `Taskvars.yml`: - -```yaml -version: '2' - -vars: - GREETING: Hello, World! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -The variable priority order changed to the following: - -1. Task variables -2. Call variables -3. Taskfile variables -4. Taskvars file variables -5. Environment variables - -A new global option was added to configure the number of variables expansions (which default to 2): - -```yaml -version: '2' - -expansions: 3 - -vars: - FOO: foo - BAR: bar - BAZ: baz - FOOBAR: '{{.FOO}}{{.BAR}}' - FOOBARBAZ: '{{.FOOBAR}}{{.BAZ}}' - -tasks: - default: - cmds: - - echo "{{.FOOBARBAZ}}" -``` - -## Version 1 - -:::caution - -v1 schema support was removed in Task >= v3.0.0. - -::: - -In the first version of the `Taskfile`, the `version:` key was not available, because the tasks was in the root of the YAML document. Like this: - -```yaml -echo: - cmds: - - echo "Hello, World!" -``` - -The variable priority order was also different: - -1. Call variables -2. Environment -3. Task variables -4. `Taskvars.yml` variables - - - - -[deprecate-version-2-schema]: /deprecations/version-2-schema/ -[output]: /usage#output-syntax -[ignore_errors]: /usage#ignore-errors -[includes]: /usage#including-other-taskfiles diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/translate.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/translate.md deleted file mode 100644 index 34cdd719..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/translate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -slug: /translate/ -sidebar_position: 12 ---- - -# Translate - -Want to help us translate this documentation? In this document we explain how. - -Do NOT edit translated markdown files directly on the GitHub repository! We use [Crowdin][crowdin] to allow contributors on work on translations. The repository is periodically updated with progress from Crowdin. - -If you want to have access to the Crowdin project to be able to suggest translations, please ask for access on the [#translations channel on our Discord server][discord]. If a given language is not being shown to Crowdin yet, just ask and we can configure it. - - - - -[crowdin]: https://crowdin.com/project/taskfile -[discord]: https://discord.gg/6TY36E39UK diff --git a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/usage.md b/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/usage.md deleted file mode 100644 index 0691dc63..00000000 --- a/docs/i18n/es-ES/docusaurus-plugin-content-docs/current/usage.md +++ /dev/null @@ -1,1624 +0,0 @@ ---- -slug: /usage/ -sidebar_position: 3 ---- - -# Usage - -## Getting started - -Create a file called `Taskfile.yml` in the root of your project. The `cmds` attribute should contain the commands of a task. The example below allows compiling a Go app and uses [esbuild](https://esbuild.github.io/) to concat and minify multiple CSS files into a single one. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -Running the tasks is as simple as running: - -```bash -task assets build -``` - -Task uses [mvdan.cc/sh](https://mvdan.cc/sh/), a native Go sh interpreter. So you can write sh/bash commands, and it will work even on Windows, where `sh` or `bash` are usually not available. Just remember any executable called must be available by the OS or in PATH. - -If you omit a task name, "default" will be assumed. - -## Supported file names - -Task will look for the following file names, in order of priority: - -- Taskfile.yml -- taskfile.yml -- Taskfile.yaml -- taskfile.yaml -- Taskfile.dist.yml -- taskfile.dist.yml -- Taskfile.dist.yaml -- taskfile.dist.yaml - -The intention of having the `.dist` variants is to allow projects to have one committed version (`.dist`) while still allowing individual users to override the Taskfile by adding an additional `Taskfile.yml` (which would be on `.gitignore`). - -### Running a Taskfile from a subdirectory - -If a Taskfile cannot be found in the current working directory, it will walk up the file tree until it finds one (similar to how `git` works). When running Task from a subdirectory like this, it will behave as if you ran it from the directory containing the Taskfile. - -You can use this functionality along with the special `{{.USER_WORKING_DIR}}` variable to create some very useful reusable tasks. For example, if you have a monorepo with directories for each microservice, you can `cd` into a microservice directory and run a task command to bring it up without having to create multiple tasks or Taskfiles with identical content. For example: - -```yaml -version: '3' - -tasks: - up: - dir: '{{.USER_WORKING_DIR}}' - preconditions: - - test -f docker-compose.yml - cmds: - - docker-compose up -d -``` - -In this example, we can run `cd ` and `task up` and as long as the `` directory contains a `docker-compose.yml`, the Docker composition will be brought up. - -### Running a global Taskfile - -If you call Task with the `--global` (alias `-g`) flag, it will look for your home directory instead of your working directory. In short, Task will look for a Taskfile that matches `$HOME/{T,t}askfile.{yml,yaml}` . - -This is useful to have automation that you can run from anywhere in your system! - -:::info - -When running your global Taskfile with `-g`, tasks will run on `$HOME` by default, and not on your working directory! - -As mentioned in the previous section, the `{{.USER_WORKING_DIR}}` special variable can be very handy here to run stuff on the directory you're calling `task -g` from. - -```yaml -version: '3' - -tasks: - from-home: - cmds: - - pwd - - from-working-directory: - dir: '{{.USER_WORKING_DIR}}' - cmds: - - pwd -``` - -::: - -## Environment variables - -### Task - -You can use `env` to set custom environment variables for a specific task: - -```yaml -version: '3' - -tasks: - greet: - cmds: - - echo $GREETING - env: - GREETING: Hey, there! -``` - -Additionally, you can set global environment variables that will be available to all tasks: - -```yaml -version: '3' - -env: - GREETING: Hey, there! - -tasks: - greet: - cmds: - - echo $GREETING -``` - -:::info - -`env` supports expansion and retrieving output from a shell command just like variables, as you can see in the [Variables](#variables) section. - -::: - -### .env files - -You can also ask Task to include `.env` like files by using the `dotenv:` setting: - -```bash title=".env" -KEYNAME=VALUE -``` - -```bash title="testing/.env" -ENDPOINT=testing.com -``` - -```yaml title="Taskfile.yml" -version: '3' - -env: - ENV: testing - -dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - -tasks: - greet: - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Dotenv files can also be specified at the task level: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Environment variables specified explicitly at the task-level will override variables defined in dotfiles: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - env: - KEYNAME: DIFFERENT_VALUE - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -:::info - -Please note that you are not currently able to use the `dotenv` key inside included Taskfiles. - -::: - -## Including other Taskfiles - -If you want to share tasks between different projects (Taskfiles), you can use the importing mechanism to include other Taskfiles using the `includes` keyword: - -```yaml -version: '3' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -The tasks described in the given Taskfiles will be available with the informed namespace. So, you'd call `task docs:serve` to run the `serve` task from `documentation/Taskfile.yml` or `task docker:build` to run the `build` task from the `DockerTasks.yml` file. - -Relative paths are resolved relative to the directory containing the including Taskfile. - -### OS-specific Taskfiles - -With `version: '2'`, task automatically includes any `Taskfile_{{OS}}.yml` if it exists (for example: `Taskfile_windows.yml`, `Taskfile_linux.yml` or `Taskfile_darwin.yml`). Since this behavior was a bit too implicit, it was removed on version 3, but you still can have a similar behavior by explicitly importing these files: - -```yaml -version: '3' - -includes: - build: ./Taskfile_{{OS}}.yml -``` - -### Directory of included Taskfile - -By default, included Taskfile's tasks are run in the current directory, even if the Taskfile is in another directory, but you can force its tasks to run in another directory by using this alternative syntax: - -```yaml -version: '3' - -includes: - docs: - taskfile: ./docs/Taskfile.yml - dir: ./docs -``` - -:::info - -The included Taskfiles must be using the same schema version as the main Taskfile uses. - -::: - -### Optional includes - -Includes marked as optional will allow Task to continue execution as normal if the included file is missing. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./tests/Taskfile.yml - optional: true - -tasks: - greet: - cmds: - - echo "This command can still be successfully executed if - ./tests/Taskfile.yml does not exist" -``` - -### Internal includes - -Includes marked as internal will set all the tasks of the included file to be internal as well (see the [Internal tasks](#internal-tasks) section below). This is useful when including utility tasks that are not intended to be used directly by the user. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./taskfiles/Utils.yml - internal: true -``` - -### Vars of included Taskfiles - -You can also specify variables when including a Taskfile. This may be useful for having reusable Taskfile that can be tweaked or even included more than once: - -```yaml -version: '3' - -includes: - backend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: backend_image - - frontend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: frontend_image -``` - -### Namespace aliases - -When including a Taskfile, you can give the namespace a list of `aliases`. This works in the same way as [task aliases](#task-aliases) and can be used together to create shorter and easier-to-type commands. - -```yaml -version: '3' - -includes: - generate: - taskfile: ./taskfiles/Generate.yml - aliases: [gen] -``` - -:::info - -Vars declared in the included Taskfile have preference over the variables in the including Taskfile! If you want a variable in an included Taskfile to be overridable, use the [default function](https://go-task.github.io/slim-sprig/defaults.html): `MY_VAR: '{{.MY_VAR | default "my-default-value"}}'`. - -::: - -## Internal tasks - -Internal tasks are tasks that cannot be called directly by the user. They will not appear in the output when running `task --list|--list-all`. Other tasks may call internal tasks in the usual way. This is useful for creating reusable, function-like tasks that have no useful purpose on the command line. - -```yaml -version: '3' - -tasks: - build-image-1: - cmds: - - task: build-image - vars: - DOCKER_IMAGE: image-1 - - build-image: - internal: true - cmds: - - docker build -t {{.DOCKER_IMAGE}} . -``` - -## Task directory - -By default, tasks will be executed in the directory where the Taskfile is located. But you can easily make the task run in another folder, informing `dir`: - -```yaml -version: '3' - -tasks: - serve: - dir: public/www - cmds: - # run http server - - caddy -``` - -If the directory does not exist, `task` creates it. - -## Task dependencies - -> Dependencies run in parallel, so dependencies of a task should not depend one another. If you want to force tasks to run serially, take a look at the [Calling Another Task](#calling-another-task) section below. - -You may have tasks that depend on others. Just pointing them on `deps` will make them run automatically before running the parent task: - -```yaml -version: '3' - -tasks: - build: - deps: [assets] - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -In the above example, `assets` will always run right before `build` if you run `task build`. - -A task can have only dependencies and no commands to group tasks together: - -```yaml -version: '3' - -tasks: - assets: - deps: [js, css] - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -If there is more than one dependency, they always run in parallel for better performance. - -:::tip - -You can also make the tasks given by the command line run in parallel by using the `--parallel` flag (alias `-p`). Example: `task --parallel js css`. - -::: - -If you want to pass information to dependencies, you can do that the same manner as you would to [call another task](#calling-another-task): - -```yaml -version: '3' - -tasks: - default: - deps: - - task: echo_sth - vars: { TEXT: 'before 1' } - - task: echo_sth - vars: { TEXT: 'before 2' } - silent: true - cmds: - - echo "after" - - echo_sth: - cmds: - - echo {{.TEXT}} -``` - -## Platform specific tasks and commands - -If you want to restrict the running of tasks to explicit platforms, this can be achieved using the `platforms:` key. Tasks can be restricted to a specific OS, architecture or a combination of both. On a mismatch, the task or command will be skipped, and no error will be thrown. - -The values allowed as OS or Arch are valid `GOOS` and `GOARCH` values, as defined by the Go language [here](https://github.com/golang/go/blob/master/src/go/build/syslist.go). - -The `build-windows` task below will run only on Windows, and on any architecture: - -```yaml -version: '3' - -tasks: - build-windows: - platforms: [windows] - cmds: - - echo 'Running command on Windows' -``` - -This can be restricted to a specific architecture as follows: - -```yaml -version: '3' - -tasks: - build-windows-amd64: - platforms: [windows/amd64] - cmds: - - echo 'Running command on Windows (amd64)' -``` - -It is also possible to restrict the task to specific architectures: - -```yaml -version: '3' - -tasks: - build-amd64: - platforms: [amd64] - cmds: - - echo 'Running command on amd64' -``` - -Multiple platforms can be specified as follows: - -```yaml -version: '3' - -tasks: - build: - platforms: [windows/amd64, darwin] - cmds: - - echo 'Running command on Windows (amd64) and macOS' -``` - -Individual commands can also be restricted to specific platforms: - -```yaml -version: '3' - -tasks: - build: - cmds: - - cmd: echo 'Running command on Windows (amd64) and macOS' - platforms: [windows/amd64, darwin] - - cmd: echo 'Running on all platforms' -``` - -## Calling another task - -When a task has many dependencies, they are executed concurrently. This will often result in a faster build pipeline. However, in some situations, you may need to call other tasks serially. In this case, use the following syntax: - -```yaml -version: '3' - -tasks: - main-task: - cmds: - - task: task-to-be-called - - task: another-task - - echo "Both done" - - task-to-be-called: - cmds: - - echo "Task to be called" - - another-task: - cmds: - - echo "Another task" -``` - -Using the `vars` and `silent` attributes you can choose to pass variables and toggle [silent mode](#silent-mode) on a call-by-call basis: - -```yaml -version: '3' - -tasks: - greet: - vars: - RECIPIENT: '{{default "World" .RECIPIENT}}' - cmds: - - echo "Hello, {{.RECIPIENT}}!" - - greet-pessimistically: - cmds: - - task: greet - vars: { RECIPIENT: 'Cruel World' } - silent: true -``` - -The above syntax is also supported in `deps`. - -:::tip - -NOTE: If you want to call a task declared in the root Taskfile from within an [included Taskfile](#including-other-taskfiles), add a leading `:` like this: `task: :task-name`. - -::: - -## Prevent unnecessary work - -### By fingerprinting locally generated files and their sources - -If a task generates something, you can inform Task the source and generated files, so Task will prevent running them if not necessary. - -```yaml -version: '3' - -tasks: - build: - deps: [js, css] - cmds: - - go build -v -i main.go - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - sources: - - src/js/**/*.js - generates: - - public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css - sources: - - src/css/**/*.css - generates: - - public/bundle.css -``` - -`sources` and `generates` can be files or glob patterns. When given, Task will compare the checksum of the source files to determine if it's necessary to run the task. If not, it will just print a message like `Task "js" is up to date`. - -`exclude:` can also be used to exclude files from fingerprinting. Sources are evaluated in order, so `exclude:` must come after the positive glob it is negating. - -```yaml -version: '3' - -tasks: - css: - sources: - - mysources/**/*.css - - exclude: mysources/ignoreme.css - generates: - - public/bundle.css -``` - -If you prefer these check to be made by the modification timestamp of the files, instead of its checksum (content), just set the `method` property to `timestamp`. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build . - sources: - - ./*.go - generates: - - app{{exeExt}} - method: timestamp -``` - -In situations where you need more flexibility the `status` keyword can be used. You can even combine the two. See the documentation for [status](#using-programmatic-checks-to-indicate-a-task-is-up-to-date) for an example. - -:::info - -By default, task stores checksums on a local `.task` directory in the project's directory. Most of the time, you'll want to have this directory on `.gitignore` (or equivalent) so it isn't committed. (If you have a task for code generation that is committed it may make sense to commit the checksum of that task as well, though). - -If you want these files to be stored in another directory, you can set a `TASK_TEMP_DIR` environment variable in your machine. It can contain a relative path like `tmp/task` that will be interpreted as relative to the project directory, or an absolute or home path like `/tmp/.task` or `~/.task` (subdirectories will be created for each project). - -```bash -export TASK_TEMP_DIR='~/.task' -``` - -::: - -:::info - -Each task has only one checksum stored for its `sources`. If you want to distinguish a task by any of its input variables, you can add those variables as part of the task's label, and it will be considered a different task. - -This is useful if you want to run a task once for each distinct set of inputs until the sources actually change. For example, if the sources depend on the value of a variable, or you if you want the task to rerun if some arguments change even if the source has not. - -::: - -:::tip - -The method `none` skips any validation and always run the task. - -::: - -:::info - -For the `checksum` (default) or `timestamp` method to work, it is only necessary to inform the source files. When the `timestamp` method is used, the last time of the running the task is considered as a generate. - -::: - -### Using programmatic checks to indicate a task is up to date - -Alternatively, you can inform a sequence of tests as `status`. If no error is returned (exit status 0), the task is considered up-to-date: - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - status: - - test -d directory - - test -f directory/file1.txt - - test -f directory/file2.txt -``` - -Normally, you would use `sources` in combination with `generates` - but for tasks that generate remote artifacts (Docker images, deploys, CD releases) the checksum source and timestamps require either access to the artifact or for an out-of-band refresh of the `.checksum` fingerprint file. - -Two special variables `{{.CHECKSUM}}` and `{{.TIMESTAMP}}` are available for interpolation within `status` commands, depending on the method assigned to fingerprint the sources. Only `source` globs are fingerprinted. - -Note that the `{{.TIMESTAMP}}` variable is a "live" Go `time.Time` struct, and can be formatted using any of the methods that `time.Time` responds to. - -See [the Go Time documentation](https://golang.org/pkg/time/) for more information. - -You can use `--force` or `-f` if you want to force a task to run even when up-to-date. - -Also, `task --status [tasks]...` will exit with a non-zero exit code if any of the tasks are not up-to-date. - -`status` can be combined with the [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) to have a task run if either the the source/generated artifacts changes, or the programmatic check fails: - -```yaml -version: '3' - -tasks: - build:prod: - desc: Build for production usage. - cmds: - - composer install - # Run this task if source files changes. - sources: - - composer.json - - composer.lock - generates: - - ./vendor/composer/installed.json - - ./vendor/autoload.php - # But also run the task if the last build was not a production build. - status: - - grep -q '"dev": false' ./vendor/composer/installed.json -``` - -### Using programmatic checks to cancel the execution of a task and its dependencies - -In addition to `status` checks, `preconditions` checks are the logical inverse of `status` checks. That is, if you need a certain set of conditions to be _true_ you can use the `preconditions` stanza. `preconditions` are similar to `status` lines, except they support `sh` expansion, and they SHOULD all return 0. - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - preconditions: - - test -f .env - - sh: '[ 1 = 0 ]' - msg: "One doesn't equal Zero, Halting" -``` - -Preconditions can set specific failure messages that can tell a user what steps to take using the `msg` field. - -If a task has a dependency on a sub-task with a precondition, and that precondition is not met - the calling task will fail. Note that a task executed with a failing precondition will not run unless `--force` is given. - -Unlike `status`, which will skip a task if it is up to date and continue executing tasks that depend on it, a `precondition` will fail a task, along with any other tasks that depend on it. - -```yaml -version: '3' - -tasks: - task-will-fail: - preconditions: - - sh: 'exit 1' - - task-will-also-fail: - deps: - - task-will-fail - - task-will-still-fail: - cmds: - - task: task-will-fail - - echo "I will not run" -``` - -### Limiting when tasks run - -If a task executed by multiple `cmds` or multiple `deps` you can control when it is executed using `run`. `run` can also be set at the root of the Taskfile to change the behavior of all the tasks unless explicitly overridden. - -Supported values for `run`: - -- `always` (default) always attempt to invoke the task regardless of the number of previous executions -- `once` only invoke this task once regardless of the number of references -- `when_changed` only invokes the task once for each unique set of variables passed into the task - -```yaml -version: '3' - -tasks: - default: - cmds: - - task: generate-file - vars: { CONTENT: '1' } - - task: generate-file - vars: { CONTENT: '2' } - - task: generate-file - vars: { CONTENT: '2' } - - generate-file: - run: when_changed - deps: - - install-deps - cmds: - - echo {{.CONTENT}} - - install-deps: - run: once - cmds: - - sleep 5 # long operation like installing packages -``` - -### Ensuring required variables are set - -If you want to check that certain variables are set before running a task then you can use `requires`. This is useful when might not be clear to users which variables are needed, or if you want clear message about what is required. Also some tasks could have dangerous side effects if run with un-set variables. - -Using `requires` you specify an array of strings in the `vars` sub-section under `requires`, these strings are variable names which are checked prior to running the task. If any variables are un-set the the task will error and not run. - -Environmental variables are also checked. - -Syntax: - -```yaml -requires: - vars: [] # Array of strings -``` - -:::note - -Variables set to empty zero length strings, will pass the `requires` check. - -::: - -Example of using `requires`: - -```yaml -version: '3' - -tasks: - docker-build: - cmds: - - 'docker build . -t {{.IMAGE_NAME}}:{{.IMAGE_TAG}}' - - # Make sure these variables are set before running - requires: - vars: [IMAGE_NAME, IMAGE_TAG] -``` - -## Variables - -When doing interpolation of variables, Task will look for the below. They are listed below in order of importance (i.e. most important first): - -- Variables declared in the task definition -- Variables given while calling a task from another (See [Calling another task](#calling-another-task) above) -- Variables of the [included Taskfile](#including-other-taskfiles) (when the task is included) -- Variables of the [inclusion of the Taskfile](#vars-of-included-taskfiles) (when the task is included) -- Global variables (those declared in the `vars:` option in the Taskfile) -- Environment variables - -Example of sending parameters with environment variables: - -```bash -$ TASK_VARIABLE=a-value task do-something -``` - -:::tip - -A special variable `.TASK` is always available containing the task name. - -::: - -Since some shells do not support the above syntax to set environment variables (Windows) tasks also accept a similar style when not at the beginning of the command. - -```bash -$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!" -``` - -Example of locally declared vars: - -```yaml -version: '3' - -tasks: - print-var: - cmds: - - echo "{{.VAR}}" - vars: - VAR: Hello! -``` - -Example of global vars in a `Taskfile.yml`: - -```yaml -version: '3' - -vars: - GREETING: Hello from Taskfile! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -### Dynamic variables - -The below syntax (`sh:` prop in a variable) is considered a dynamic variable. The value will be treated as a command and the output assigned. If there are one or more trailing newlines, the last newline will be trimmed. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go - vars: - GIT_COMMIT: - sh: git log -n 1 --format=%h -``` - -This works for all types of variables. - -## Looping over values - -As of v3.28.0, Task allows you to loop over certain values and execute a command for each. There are a number of ways to do this depending on the type of value you want to loop over. - -### Looping over a static list - -The simplest kind of loop is an explicit one. This is useful when you want to loop over a set of values that are known ahead of time. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: ['foo.txt', 'bar.txt'] - cmd: cat {{ .ITEM }} -``` - -### Looping over your task's sources - -You are also able to loop over the sources of your task: - -```yaml -version: '3' - -tasks: - default: - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{ .ITEM }} -``` - -This will also work if you use globbing syntax in your sources. For example, if you specify a source for `*.txt`, the loop will iterate over all files that match that glob. - -Source paths will always be returned as paths relative to the task directory. If you need to convert this to an absolute path, you can use the built-in `joinPath` function. There are some [special variables](/api/#special-variables) that you may find useful for this. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_DIR: /path/to/dir - dir: '{{.MY_DIR}}' - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{joinPath .MY_DIR .ITEM}} -``` - -### Looping over variables - -To loop over the contents of a variable, you simply need to specify the variable you want to loop over. By default, variables will be split on any whitespace characters. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -If you need to split on a different character, you can do this by specifying the `split` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt,bar.txt - cmds: - - for: { var: MY_VAR, split: ',' } - cmd: cat {{.ITEM}} -``` - -All of this also works with dynamic variables! - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: - sh: find -type f -name '*.txt' - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -### Renaming variables - -If you want to rename the iterator variable to make it clearer what the value contains, you can do so by specifying the `as` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR, as: FILE } - cmd: cat {{.FILE}} -``` - -### Looping over tasks - -Because the `for` property is defined at the `cmds` level, you can also use it alongside the `task` keyword to run tasks multiple times with different variables. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: my-task - vars: - FILE: '{{.ITEM}}' - - my-task: - cmds: - - echo '{{.FILE}}' -``` - -Or if you want to run different tasks depending on the value of the loop: - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: task-{{.ITEM}} - - task-foo: - cmds: - - echo 'foo' - - task-bar: - cmds: - - echo 'bar' -``` - -## Forwarding CLI arguments to commands - -If `--` is given in the CLI, all following parameters are added to a special `.CLI_ARGS` variable. This is useful to forward arguments to another command. - -The below example will run `yarn install`. - -```bash -$ task yarn -- install -``` - -```yaml -version: '3' - -tasks: - yarn: - cmds: - - yarn {{.CLI_ARGS}} -``` - -## Doing task cleanup with `defer` - -With the `defer` keyword, it's possible to schedule cleanup to be run once the task finishes. The difference with just putting it as the last command is that this command will run even when the task fails. - -In the example below, `rm -rf tmpdir/` will run even if the third command fails: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: rm -rf tmpdir/ - - echo 'Do work on tmpdir/' -``` - -If you want to move the cleanup command into another task, that is possible as well: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: { task: cleanup } - - echo 'Do work on tmpdir/' - - cleanup: rm -rf tmpdir/ -``` - -:::info - -Due to the nature of how the [Go's own `defer` work](https://go.dev/tour/flowcontrol/13), the deferred commands are executed in the reverse order if you schedule multiple of them. - -::: - -## Go's template engine - -Task parse commands as [Go's template engine][gotemplate] before executing them. Variables are accessible through dot syntax (`.VARNAME`). - -All functions by the Go's [slim-sprig lib](https://go-task.github.io/slim-sprig/) are available. The following example gets the current date in a given format: - -```yaml -version: '3' - -tasks: - print-date: - cmds: - - echo {{now | date "2006-01-02"}} -``` - -Task also adds the following functions: - -- `OS`: Returns the operating system. Possible values are `windows`, `linux`, `darwin` (macOS) and `freebsd`. -- `ARCH`: return the architecture Task was compiled to: `386`, `amd64`, `arm` or `s390x`. -- `splitLines`: Splits Unix (`\n`) and Windows (`\r\n`) styled newlines. -- `catLines`: Replaces Unix (`\n`) and Windows (`\r\n`) styled newlines with a space. -- `toSlash`: Does nothing on Unix, but on Windows converts a string from `\` path format to `/`. -- `fromSlash`: Opposite of `toSlash`. Does nothing on Unix, but on Windows converts a string from `/` path format to `\`. -- `exeExt`: Returns the right executable extension for the current OS (`".exe"` for Windows, `""` for others). -- `shellQuote`: Quotes a string to make it safe for use in shell scripts. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote) for this. The Bash dialect is assumed. -- `splitArgs`: Splits a string as if it were a command's arguments. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/shell#Fields) - -Example: - -```yaml -version: '3' - -tasks: - print-os: - cmds: - - echo '{{OS}} {{ARCH}}' - - echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}' - # This will be path/to/file on Unix but path\to\file on Windows - - echo '{{fromSlash "path/to/file"}}' - enumerated-file: - vars: - CONTENT: | - foo - bar - cmds: - - | - cat << EOF > output.txt - {{range $i, $line := .CONTENT | splitLines -}} - {{printf "%3d" $i}}: {{$line}} - {{end}}EOF -``` - -## Help - -Running `task --list` (or `task -l`) lists all tasks with a description. The following Taskfile: - -```yaml -version: '3' - -tasks: - build: - desc: Build the go binary. - cmds: - - go build -v -i main.go - - test: - desc: Run all the go tests. - cmds: - - go test -race ./... - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -would print the following output: - -```bash -* build: Build the go binary. -* test: Run all the go tests. -``` - -If you want to see all tasks, there's a `--list-all` (alias `-a`) flag as well. - -## Display summary of task - -Running `task --summary task-name` will show a summary of a task. The following Taskfile: - -```yaml -version: '3' - -tasks: - release: - deps: [build] - summary: | - Release your project to github - - It will build your project before starting the release. - Please make sure that you have set GITHUB_TOKEN before starting. - cmds: - - your-release-tool - - build: - cmds: - - your-build-tool -``` - -with running `task --summary release` would print the following output: - -``` -task: release - -Release your project to github - -It will build your project before starting the release. -Please make sure that you have set GITHUB_TOKEN before starting. - -dependencies: - - build - -commands: - - your-release-tool -``` - -If a summary is missing, the description will be printed. If the task does not have a summary or a description, a warning is printed. - -Please note: _showing the summary will not execute the command_. - -## Task aliases - -Aliases are alternative names for tasks. They can be used to make it easier and quicker to run tasks with long or hard-to-type names. You can use them on the command line, when [calling sub-tasks](#calling-another-task) in your Taskfile and when [including tasks](#including-other-taskfiles) with aliases from another Taskfile. They can also be used together with [namespace aliases](#namespace-aliases). - -```yaml -version: '3' - -tasks: - generate: - aliases: [gen] - cmds: - - task: gen-mocks - - generate-mocks: - aliases: [gen-mocks] - cmds: - - echo "generating..." -``` - -## Overriding task name - -Sometimes you may want to override the task name printed on the summary, up-to-date messages to STDOUT, etc. In this case, you can just set `label:`, which can also be interpolated with variables: - -```yaml -version: '3' - -tasks: - default: - - task: print - vars: - MESSAGE: hello - - task: print - vars: - MESSAGE: world - - print: - label: 'print-{{.MESSAGE}}' - cmds: - - echo "{{.MESSAGE}}" -``` - -## Warning Prompts - -Warning Prompts are used to prompt a user for confirmation before a task is executed. - -Below is an example using `prompt` with a dangerous command, that is called between two safe commands: - -```yaml -version: '3' - -tasks: - example: - cmds: - - task: not-dangerous - - task: dangerous - - task: another-not-dangerous - - not-dangerous: - cmds: - - echo 'not dangerous command' - - another-not-dangerous: - cmds: - - echo 'another not dangerous command' - - dangerous: - prompt: This is a dangerous command... Do you want to continue? - cmds: - - echo 'dangerous command' -``` - -```bash -❯ task dangerous -task: "This is a dangerous command... Do you want to continue?" [y/N] -``` - -Warning prompts are called before executing a task. If a prompt is denied Task will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue as normal. - -```bash -❯ task example -not dangerous command -task: "This is a dangerous command. Do you want to continue?" [y/N] -y -dangerous command -another not dangerous command -``` - -To skip warning prompts automatically, you can use the `--yes` (alias `-y`) option when calling the task. By including this option, all warnings, will be automatically confirmed, and no prompts will be shown. - -:::caution - -Tasks with prompts always fail by default on non-terminal environments, like a CI, where an `stdin` won't be available for the user to answer. In those cases, use `--yes` (`-y`) to force all tasks with a prompt to run. - -::: - -## Silent mode - -Silent mode disables the echoing of commands before Task runs it. For the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" -``` - -Normally this will be printed: - -```sh -echo "Print something" -Print something -``` - -With silent mode on, the below will be printed instead: - -```sh -Print something -``` - -There are four ways to enable silent mode: - -- At command level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: echo "Print something" - silent: true -``` - -- At task level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" - silent: true -``` - -- Globally at Taskfile level: - -```yaml -version: '3' - -silent: true - -tasks: - echo: - cmds: - - echo "Print something" -``` - -- Or globally with `--silent` or `-s` flag - -If you want to suppress STDOUT instead, just redirect a command to `/dev/null`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "This will print nothing" > /dev/null -``` - -## Dry run mode - -Dry run mode (`--dry`) compiles and steps through each task, printing the commands that would be run without executing them. This is useful for debugging your Taskfiles. - -## Ignore errors - -You have the option to ignore errors during command execution. Given the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - exit 1 - - echo "Hello World" -``` - -Task will abort the execution after running `exit 1` because the status code `1` stands for `EXIT_FAILURE`. However, it is possible to continue with execution using `ignore_error`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "Hello World" -``` - -`ignore_error` can also be set for a task, which means errors will be suppressed for all commands. Nevertheless, keep in mind that this option will not propagate to other tasks called either by `deps` or `cmds`! - -## Output syntax - -By default, Task just redirects the STDOUT and STDERR of the running commands to the shell in real-time. This is good for having live feedback for logging printed by commands, but the output can become messy if you have multiple commands running simultaneously and printing lots of stuff. - -To make this more customizable, there are currently three different output options you can choose: - -- `interleaved` (default) -- `group` -- `prefixed` - -To choose another one, just set it to root in the Taskfile: - -```yaml -version: '3' - -output: 'group' - -tasks: - # ... -``` - -The `group` output will print the entire output of a command once after it finishes, so you will not have live feedback for commands that take a long time to run. - -When using the `group` output, you can optionally provide a templated message to print at the start and end of the group. This can be useful for instructing CI systems to group all of the output for a given task, such as with [GitHub Actions' `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) or [Azure Pipelines](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?expand=1&view=azure-devops&tabs=bash#formatting-commands). - -```yaml -version: '3' - -output: - group: - begin: '::group::{{.TASK}}' - end: '::endgroup::' - -tasks: - default: - cmds: - - echo 'Hello, World!' - silent: true -``` - -```bash -$ task default -::group::default -Hello, World! -::endgroup:: -``` - -When using the `group` output, you may swallow the output of the executed command on standard output and standard error if it does not fail (zero exit code). - -```yaml -version: '3' - -silent: true - -output: - group: - error_only: true - -tasks: - passes: echo 'output-of-passes' - errors: echo 'output-of-errors' && exit 1 -``` - -```bash -$ task passes -$ task errors -output-of-errors -task: Failed to run task "errors": exit status 1 -``` - -The `prefix` output will prefix every line printed by a command with `[task-name]` as the prefix, but you can customize the prefix for a command with the `prefix:` attribute: - -```yaml -version: '3' - -output: prefixed - -tasks: - default: - deps: - - task: print - vars: { TEXT: foo } - - task: print - vars: { TEXT: bar } - - task: print - vars: { TEXT: baz } - - print: - cmds: - - echo "{{.TEXT}}" - prefix: 'print-{{.TEXT}}' - silent: true -``` - -```bash -$ task default -[print-foo] foo -[print-bar] bar -[print-baz] baz -``` - -:::tip - -The `output` option can also be specified by the `--output` or `-o` flags. - -::: - -## Interactive CLI application - -When running interactive CLI applications inside Task they can sometimes behave weirdly, especially when the [output mode](#output-syntax) is set to something other than `interleaved` (the default), or when interactive apps are run in parallel with other tasks. - -The `interactive: true` tells Task this is an interactive application and Task will try to optimize for it: - -```yaml -version: '3' - -tasks: - default: - cmds: - - vim my-file.txt - interactive: true -``` - -If you still have problems running an interactive app through Task, please open an issue about it. - -## Short task syntax - -Starting on Task v3, you can now write tasks with a shorter syntax if they have the default settings (e.g. no custom `env:`, `vars:`, `desc:`, `silent:` , etc): - -```yaml -version: '3' - -tasks: - build: go build -v -o ./app{{exeExt}} . - - run: - - task: build - - ./app{{exeExt}} -h localhost -p 8080 -``` - -## `set` and `shopt` - -It's possible to specify options to the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins. This can be added at global, task or command level. - -```yaml -version: '3' - -set: [pipefail] -shopt: [globstar] - -tasks: - # `globstar` required for double star globs to work - default: echo **/*.go -``` - -:::info - -Keep in mind that not all options are available in the [shell interpreter library](https://github.com/mvdan/sh) that Task uses. - -::: - -## Watch tasks - -With the flags `--watch` or `-w` task will watch for file changes and run the task again. This requires the `sources` attribute to be given, so task knows which files to watch. - -The default watch interval is 5 seconds, but it's possible to change it by either setting `interval: '500ms'` in the root of the Taskfile passing it as an argument like `--interval=500ms`. - -Also, it's possible to set `watch: true` in a given task and it'll automatically run in watch mode: - -```yaml -version: '3' - -interval: 500ms - -tasks: - build: - desc: Builds the Go application - watch: true - sources: - - '**/*.go' - cmds: - - go build # ... -``` - -:::info - -Note that when setting `watch: true` to a task, it'll only run in watch mode when running from the CLI via `task my-watch-task`, but won't run in watch mode if called by another task, either directly or as a dependency. - -::: - - - - -[gotemplate]: https://golang.org/pkg/text/template/ diff --git a/docs/i18n/es-ES/docusaurus-theme-classic/footer.json b/docs/i18n/es-ES/docusaurus-theme-classic/footer.json deleted file mode 100644 index 6293bf6e..00000000 --- a/docs/i18n/es-ES/docusaurus-theme-classic/footer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "link.title.Pages": { - "message": "Páginas", - "description": "The title of the footer links column with title=Pages in the footer" - }, - "link.title.Community": { - "message": "Comunidad", - "description": "The title of the footer links column with title=Community in the footer" - }, - "link.title.Translations": { - "message": "Traducciones", - "description": "The title of the footer links column with title=Translations in the footer" - }, - "link.item.label.Installation": { - "message": "Instalación", - "description": "The label of footer link with label=Installation linking to /installation/" - }, - "link.item.label.Usage": { - "message": "Uso", - "description": "The label of footer link with label=Usage linking to /usage/" - }, - "link.item.label.Donate": { - "message": "Donar", - "description": "The label of footer link with label=Donate linking to /donate/" - }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/go-task/task" - }, - "link.item.label.Twitter": { - "message": "Twitter", - "description": "The label of footer link with label=Twitter linking to https://twitter.com/taskfiledev" - }, - "link.item.label.Mastodon": { - "message": "Mastodon", - "description": "The label of footer link with label=Mastodon linking to https://fosstodon.org/@task" - }, - "link.item.label.Discord": { - "message": "Discord", - "description": "The label of footer link with label=Discord linking to https://discord.gg/6TY36E39UK" - }, - "link.item.label.OpenCollective": { - "message": "OpenCollective", - "description": "The label of footer link with label=OpenCollective linking to https://opencollective.com/task" - } -} diff --git a/docs/i18n/es-ES/docusaurus-theme-classic/navbar.json b/docs/i18n/es-ES/docusaurus-theme-classic/navbar.json deleted file mode 100644 index 6ee4b13b..00000000 --- a/docs/i18n/es-ES/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "title": { - "message": "Task", - "description": "The title in the navbar" - }, - "item.label.Installation": { - "message": "Instalación", - "description": "Navbar item with label Installation" - }, - "item.label.Usage": { - "message": "Guía de uso", - "description": "Navbar item with label Usage" - }, - "item.label.API": { - "message": "API", - "description": "Navbar item with label API" - }, - "item.label.Donate": { - "message": "Donar", - "description": "Navbar item with label Donate" - }, - "item.label.GitHub": { - "message": "GitHub", - "description": "Navbar item with label GitHub" - }, - "item.label.Twitter": { - "message": "Twitter", - "description": "Navbar item with label Twitter" - }, - "item.label.Mastodon": { - "message": "Mastodon", - "description": "Navbar item with label Mastodon" - }, - "item.label.Discord": { - "message": "Discord", - "description": "Navbar item with label Discord" - } -} diff --git a/docs/i18n/fr-FR/code.json b/docs/i18n/fr-FR/code.json deleted file mode 100644 index 83261d27..00000000 --- a/docs/i18n/fr-FR/code.json +++ /dev/null @@ -1,396 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "Cette page a rencontré un problème.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Veuillez réessayer", - "description": "The label of the button to try again when the page crashed" - }, - "theme.NotFound.title": { - "message": "Page non trouvée", - "description": "The title of the 404 page" - }, - "theme.NotFound.p1": { - "message": "Nous n'avons pas trouvé ce que vous recherchiez.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Veuillez contacter le propriétaire du site qui vous a lié à l'URL d'origine et lui faire savoir que son lien est rompu.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.admonition.note": { - "message": "note", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "conseils", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.danger": { - "message": "danger", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "info", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.caution": { - "message": "attention", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Retour en haut de la page", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "Archiver", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Archiver", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Navigation dans la page de la liste des blogs", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Nouvelles entrées", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Anciennes Entrées", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Navigation dans la page d'article du blog", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Article récent", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Article plus ancien", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "Un article|{count} articles", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} tagués avec « {tagName} »", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "Voir tous les tags", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Basculer entre le mode sombre et le mode clair (actuellement {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "mode sombre", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "mode clair", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.home": { - "message": "Page d’accueil", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Fil d'Ariane", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} éléments", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Navigation dans les pages", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Précédent", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Suivant", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "Un document tagué|{count} documents tagués", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} avec \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Version : {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "Ceci est une documentation non publiée pour la version {versionLabel} de {siteTitle}.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "Ceci est la documentation de {siteTitle} {versionLabel}, qui n'est plus activement maintenue.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "Pour une documentation à jour, consultez la {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "dernière version", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Éditer cette page", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Lien direct vers l'entête", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " le {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " par {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Dernière mise à jour{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Versions", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Tags:", - "description": "The label alongside a tag list" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Fermer", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Navigation dans les articles récents du blog", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Copié", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Copier le code dans le presse-papiers", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "Copier", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Basculer le retour à la ligne automatique", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "Plier/Déplier la catégorie '{label}' de la barre latérale", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Langues", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "Sur cette page", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "En Savoir Plus", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "En savoir plus sur {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "Une minute de lecture|{readingTime} minutes de lecture", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Réduire la barre latérale", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Réduire la barre latérale", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Fermer la barre de navigation", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "Retour au menu principal", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Afficher/Masquer la barre de navigation", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Déplier le menu latéral", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Déplier le menu latéral", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.seeAll": { - "message": "Voir les {count} résultats" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "Un document trouvé |{count} documents trouvés", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Résultats de la recherche pour \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Rechercher dans la documentation", - "description": "The search page title for empty query" - }, - "theme.SearchPage.inputPlaceholder": { - "message": "Saisissez votre recherche ici", - "description": "The placeholder for search page input" - }, - "theme.SearchPage.inputLabel": { - "message": "Rechercher", - "description": "The ARIA label for search page input" - }, - "theme.SearchPage.algoliaLabel": { - "message": "Recherche par Algolia", - "description": "The ARIA label for Algolia mention" - }, - "theme.SearchPage.noResultsText": { - "message": "Aucun résultat trouvé", - "description": "The paragraph for empty search result" - }, - "theme.SearchPage.fetchingNewResults": { - "message": "Recherche de nouveaux résultats...", - "description": "The paragraph for fetching new search results" - }, - "theme.SearchBar.label": { - "message": "Rechercher", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchModal.searchBox.resetButtonTitle": { - "message": "Effacer la recherche", - "description": "The label and ARIA label for search box reset button" - }, - "theme.SearchModal.searchBox.cancelButtonText": { - "message": "Annuler", - "description": "The label and ARIA label for search box cancel button" - }, - "theme.SearchModal.startScreen.recentSearchesTitle": { - "message": "Récent", - "description": "The title for recent searches" - }, - "theme.SearchModal.startScreen.noRecentSearchesText": { - "message": "Pas de recherches récentes", - "description": "The text when no recent searches" - }, - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { - "message": "Enregistrer cette recherche", - "description": "The label for save recent search button" - }, - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { - "message": "Supprimer cette recherche de l'historique", - "description": "The label for remove recent search button" - }, - "theme.SearchModal.startScreen.favoriteSearchesTitle": { - "message": "Favoris", - "description": "The title for favorite searches" - }, - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { - "message": "Supprimer cette recherche des favoris", - "description": "The label for remove favorite search button" - }, - "theme.SearchModal.errorScreen.titleText": { - "message": "Impossible de récupérer les résultats", - "description": "The title for error screen of search modal" - }, - "theme.SearchModal.errorScreen.helpText": { - "message": "Vous devriez vérifier votre connexion réseau.", - "description": "The help text for error screen of search modal" - }, - "theme.SearchModal.footer.selectText": { - "message": "sélectionner", - "description": "The explanatory text of the action for the enter key" - }, - "theme.SearchModal.footer.selectKeyAriaLabel": { - "message": "Touche Entrée", - "description": "The ARIA label for the Enter key button that makes the selection" - }, - "theme.SearchModal.footer.navigateText": { - "message": "naviguer", - "description": "The explanatory text of the action for the Arrow up and Arrow down key" - }, - "theme.SearchModal.footer.navigateUpKeyAriaLabel": { - "message": "Flèche du haut", - "description": "The ARIA label for the Arrow up key button that makes the navigation" - }, - "theme.SearchModal.footer.navigateDownKeyAriaLabel": { - "message": "Flèche du bas", - "description": "The ARIA label for the Arrow down key button that makes the navigation" - }, - "theme.SearchModal.footer.closeText": { - "message": "fermer", - "description": "The explanatory text of the action for Escape key" - }, - "theme.SearchModal.footer.closeKeyAriaLabel": { - "message": "Touche Echap", - "description": "The ARIA label for the Escape key button that close the modal" - }, - "theme.SearchModal.footer.searchByText": { - "message": "Rechercher par", - "description": "The text explain that the search is making by Algolia" - }, - "theme.SearchModal.noResultsScreen.noResultsText": { - "message": "Aucun résultat pour", - "description": "The text explains that there are no results for the following search" - }, - "theme.SearchModal.noResultsScreen.suggestedQueryText": { - "message": "Essayez de rechercher", - "description": "The text for the suggested query when no results are found for the following search" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsText": { - "message": "Pensez-vous que cette requête aurait dû retourner des résultats ?", - "description": "The text for the question where the user thinks there are missing results" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { - "message": "Faites-le nous savoir.", - "description": "The text for the link to report missing results" - }, - "theme.SearchModal.placeholder": { - "message": "Rechercher dans la documentation", - "description": "The placeholder of the input of the DocSearch pop-up modal" - }, - "theme.common.skipToMainContent": { - "message": "Accéder directement au contenu principal", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Tags", - "description": "The title of the tag list page" - } -} diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md b/docs/i18n/fr-FR/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md deleted file mode 100644 index 42d99117..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Introducing Experiments -description: A look at where task is, where it's going and how we're going to get there. -slug: task-in-2023 -authors: - - pd93 -tags: - - experiments - - breaking-changes - - roadmap - - v4 -image: https://i.imgur.com/mErPwqL.png -hide_table_of_contents: false ---- - -Lately, Task has been growing extremely quickly and I've found myself thinking a lot about the future of the project and how we continue to evolve and grow. I'm not much of a writer, but I think one of the things we could do better is to communicate these kinds of thoughts to the community. So, with that in mind, this is the first (hopefully of many) blog posts talking about Task and what we're up to. - - - -## :calendar: So, what have we been up to? - -Over the past 12 months or so, [@andreynering][] (Author and maintainer of the project) and I ([@pd93][]) have been working in our spare time to maintain and improve v3 of Task and we've made some amazing progress. Here are just some of the things we've released in that time: - -- An official [extension for VS Code][vscode-task]. -- Internal Tasks ([#818](https://github.com/go-task/task/pull/818)). -- Task aliases ([#879](https://github.com/go-task/task/pull/879)). -- Looping over tasks ([#1220](https://github.com/go-task/task/pull/1200)). -- A series of refactors to the core codebase to make it more maintainable and extensible. -- Loads of bug fixes and improvements. -- An integration with [Crowdin][crowdin]. Work is in progress on making our docs available in **7 new languages** (Special thanks to all our translators for the huge help with this!). -- And much, much more! :sparkles: - -We're also working on adding some really exciting and highly requested features to Task such as having the ability to run remote Taskfiles ([#1317](https://github.com/go-task/task/issues/1317)). - -None of this would have been possible without the [150 or so (and growing) contributors][contributors] to the project, numerous sponsors and a passionate community of users. Together we have more than doubled the number of GitHub stars to over 8400 :star: since the beginning of 2022 and this continues to accelerate. We can't thank you all enough for your help and support! :rocket: - -[![Star History Chart](https://api.star-history.com/svg?repos=go-task/task&type=Date)](https://star-history.com/#go-task/task&Date) - -## What's next? :thinking: - -It's extremely motivating to see so many people using and loving Task. However, in this time we've also seen an increase in the number of issues and feature requests. In particular, issues that require some kind of breaking change to Task. This isn't a bad thing, but as we grow we need to be more responsible about how we address these changes in a way that ensures stability and compatibility for existing users and their Taskfiles. - -At this point you're probably thinking something like: - -> "But you use [semantic versioning][semver] - Just release a new major version with your breaking changes." - -And you'd be right... sort of. In theory, this sounds great, but the reality is that we don't have the time to commit to a major overhaul of Task in one big bang release. This would require a colossal amount of time and coordination and with full time jobs and personal lives to tend to, this is a difficult commitment to make. Smaller, more frequent major releases are also a significant inconvenience for users as they have to constantly keep up-to-date with our breaking changes. Fortunately, there is a better way. - -## What's going to change? :monocle: - -Going forwards, breaking changes will be allowed into _minor_ versions of Task as "experimental features". To access these features users will need opt-in by enabling feature flags. This will allow us to release new features slowly and gather feedback from the community before making them the default behavior in a future major release. - -To prepare users for the next major release, we will maintain a list of [deprecated features][deprecations] and [experiments][experiments] on our docs website and publish information on how to migrate to the new behavior. - -You can read the [full breaking change proposal][breaking-change-proposal] and view all the [current experiments and their status][experiments-project] on GitHub including the [Gentle Force][gentle-force-experiment] and [Remote Taskfiles][remote-taskfiles-experiment] experiments. - -## What will happen to v2/v3 features? - -v2 has been [officially deprecated][deprecate-version-2-schema]. If you're still using a Taskfile with `version: "2"` at the top we _strongly recommend_ that you upgrade as soon as possible. Removing v2 will allow us to tidy up the codebase and focus on new functionality instead. - -When v4 is released, we will continue to support v3 for a period of time (bug fixes etc). However, since we are moving from a backward-compatibility model to a forwards-compatibility model, **v4 itself will not be backwards compatible with v3**. - -## v4 When? :eyes: - -:man_shrugging: When it's ready. - -In all seriousness, we don't have a timeline for this yet. We'll be working on the most serious deficiencies of the v3 API first and regularly evaluating the state of the project. When we feel its in a good, stable place and we have a clear upgrade path for users and a number of stable experiments, we'll start to think about v4. - -## :wave: Final thoughts - -Task is growing fast and we're excited to see where it goes next. We hope that the steps we're taking to improve the project and our process will help us to continue to grow. As always, if you have any questions or feedback, we encourage you to comment on or open [issues][issues] and [discussions][discussions] on GitHub. Alternatively, you can join us on [Discord][discord]. - -I plan to write more of these blog posts in the future on a variety of Task-related topics, so make sure to check in occasionally and see what we're up to! - - - - -[vscode-task]: https://github.com/go-task/vscode-task -[crowdin]: https://crowdin.com -[contributors]: https://github.com/go-task/task/graphs/contributors -[semver]: https://semver.org -[breaking-change-proposal]: https://github.com/go-task/task/discussions/1191 -[@andreynering]: https://github.com/andreynering -[@pd93]: https://github.com/pd93 -[experiments]: https://taskfile.dev/experiments -[deprecations]: https://taskfile.dev/deprecations -[deprecate-version-2-schema]: https://github.com/go-task/task/issues/1197 -[issues]: https://github.com/go-task/task/issues -[discussions]: https://github.com/go-task/task/discussions -[discord]: https://discord.gg/6TY36E39UK -[experiments-project]: https://github.com/orgs/go-task/projects/1 -[gentle-force-experiment]: https://github.com/go-task/task/issues/1200 -[remote-taskfiles-experiment]: https://github.com/go-task/task/issues/1317 diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-blog/authors.yml b/docs/i18n/fr-FR/docusaurus-plugin-content-blog/authors.yml deleted file mode 100644 index 03c3d4a5..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-blog/authors.yml +++ /dev/null @@ -1,10 +0,0 @@ -andreynering: - name: Andrey Nering - title: Mainteneur de Task - url: https://github.com/andreynering - image_url: https://github.com/andreynering.png -pd93: - name: Pete Davison - title: Mainteneur de Task - url: https://github.com/pd93 - image_url: https://github.com/pd93.png diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current.json b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index d964b7fa..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version.label": { - "message": "Suivant", - "description": "The label for version current" - } -} diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/api_reference.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/api_reference.md deleted file mode 100644 index 08cc7511..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/api_reference.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -slug: /api/ -sidebar_position: 4 -toc_min_heading_level: 2 -toc_max_heading_level: 5 ---- - -# API Reference - -## CLI - -La commande Task a la syntaxe suivante : - -```bash -task [--flags] [tasks...] [-- CLI_ARGS...] -``` - -:::tip - -If `--` is given, all remaining arguments will be assigned to a special `CLI_ARGS` variable - -::: - -| Short | Flag | Type | Default | Description | -| ----- | --------------------------- | -------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-c` | `--color` | `bool` | `true` | Colored output. Enabled by default. Set flag to `false` or use `NO_COLOR=1` to disable. | -| `-C` | `--concurrency` | `int` | `0` | Limit number tasks to run concurrently. Zero means unlimited. | -| `-d` | `--dir` | `string` | Working directory | Sets directory of execution. | -| `-n` | `--dry` | `bool` | `false` | Compiles and prints tasks in the order that they would be run, without executing them. | -| `-x` | `--exit-code` | `bool` | `false` | Pass-through the exit code of the task command. | -| `-f` | `--force` | `bool` | `false` | Forces execution even when the task is up-to-date. | -| `-g` | `--global` | `bool` | `false` | Runs global Taskfile, from `$HOME/Taskfile.{yml,yaml}`. | -| `-h` | `--help` | `bool` | `false` | Shows Task usage. | -| `-i` | `--init` | `bool` | `false` | Creates a new Taskfile.yml in the current folder. | -| `-I` | `--interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `-l` | `--list` | `bool` | `false` | Lists tasks with description of current Taskfile. | -| `-a` | `--list-all` | `bool` | `false` | Lists tasks with or without a description. | -| | `--sort` | `string` | `default` | Changes the order of the tasks when listed.
`default` - Alphanumeric with root tasks first
`alphanumeric` - Alphanumeric
`none` - No sorting (As they appear in the Taskfile) | -| | `--json` | `bool` | `false` | See [JSON Output](#json-output) | -| `-o` | `--output` | `string` | Default set in the Taskfile or `intervealed` | Sets output style: [`interleaved`/`group`/`prefixed`]. | -| | `--output-group-begin` | `string` | | Message template to print before a task's grouped output. | -| | `--output-group-end` | `string` | | Message template to print after a task's grouped output. | -| | `--output-group-error-only` | `bool` | `false` | Swallow command output on zero exit code. | -| `-p` | `--parallel` | `bool` | `false` | Executes tasks provided on command line in parallel. | -| `-s` | `--silent` | `bool` | `false` | Disables echoing. | -| `-y` | `--yes` | `bool` | `false` | Assume "yes" as answer to all prompts. | -| | `--status` | `bool` | `false` | Exits with non-zero exit code if any of the given tasks is not up-to-date. | -| | `--summary` | `bool` | `false` | Show summary about a task. | -| `-t` | `--taskfile` | `string` | `Taskfile.yml` or `Taskfile.yaml` | | -| `-v` | `--verbose` | `bool` | `false` | Enables verbose mode. | -| | `--version` | `bool` | `false` | Show Task version. | -| `-w` | `--watch` | `bool` | `false` | Enables watch of the given task. | - -## Codes de sortie - -Task will sometimes exit with specific exit codes. These codes are split into three groups with the following ranges: - -- General errors (0-99) -- Taskfile errors (100-199) -- Task errors (200-299) - -A full list of the exit codes and their descriptions can be found below: - -| Code | Description | -| ---- | ------------------------------------------------------------ | -| 0 | Success | -| 1 | An unknown error occurred | -| 100 | No Taskfile was found | -| 101 | A Taskfile already exists when trying to initialize one | -| 102 | The Taskfile is invalid or cannot be parsed | -| 103 | A remote Taskfile could not be downloaded | -| 104 | A remote Taskfile was not trusted by the user | -| 105 | A remote Taskfile was could not be fetched securely | -| 106 | No cache was found for a remote Taskfile in offline mode | -| 107 | No schema version was defined in the Taskfile | -| 200 | The specified task could not be found | -| 201 | An error occurred while executing a command inside of a task | -| 202 | The user tried to invoke a task that is internal | -| 203 | There a multiple tasks with the same name or alias | -| 204 | A task was called too many times | -| 205 | A task was cancelled by the user | -| 206 | A task was not executed due to missing required variables | - -These codes can also be found in the repository in [`errors/errors.go`](https://github.com/go-task/task/blob/main/errors/errors.go). - -:::info - -When Task is run with the `-x`/`--exit-code` flag, the exit code of any failed commands will be passed through to the user instead. - -::: - -## JSON Output - -When using the `--json` flag in combination with either the `--list` or `--list-all` flags, the output will be a JSON object with the following structure: - -```json -{ - "tasks": [ - { - "name": "", - "desc": "", - "summary": "", - "up_to_date": false, - "location": { - "line": 54, - "column": 3, - "taskfile": "/path/to/Taskfile.yml" - } - } - // ... - ], - "location": "/path/to/Taskfile.yml" -} -``` - -## Special Variables - -There are some special variables that is available on the templating system: - -| Var | Description | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CLI_ARGS` | Contain all extra arguments passed after `--` when calling Task through the CLI. | -| `CLI_FORCE` | A boolean containing whether the `--force` or `--force-all` flags were set. | -| `TASK` | The name of the current task. | -| `ROOT_DIR` | The absolute path of the root Taskfile. | -| `TASKFILE_DIR` | The absolute path of the included Taskfile. | -| `USER_WORKING_DIR` | The absolute path of the directory `task` was called from. | -| `CHECKSUM` | The checksum of the files listed in `sources`. Only available within the `status` prop and if method is set to `checksum`. | -| `TIMESTAMP` | The date object of the greatest timestamp of the files listed in `sources`. Only available within the `status` prop and if method is set to `timestamp`. | -| `TASK_VERSION` | The current version of task. | -| `ITEM` | The value of the current iteration when using the `for` property. Can be changed to a different variable name using `as:`. | - -## ENV - -Some environment variables can be overridden to adjust Task behavior. - -| ENV | Default | Description | -| -------------------- | ------- | ----------------------------------------------------------------------------------------------------------------- | -| `TASK_TEMP_DIR` | `.task` | Location of the temp dir. Can relative to the project like `tmp/task` or absolute like `/tmp/.task` or `~/.task`. | -| `TASK_COLOR_RESET` | `0` | Color used for white. | -| `TASK_COLOR_BLUE` | `34` | Color used for blue. | -| `TASK_COLOR_GREEN` | `32` | Color used for green. | -| `TASK_COLOR_CYAN` | `36` | Color used for cyan. | -| `TASK_COLOR_YELLOW` | `33` | Color used for yellow. | -| `TASK_COLOR_MAGENTA` | `35` | Color used for magenta. | -| `TASK_COLOR_RED` | `31` | Color used for red. | -| `FORCE_COLOR` | | Force color output usage. | - -## Taskfile Schema - -| Attribute | Type | Default | Description | -| ---------- | ---------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `version` | `string` | | Version of the Taskfile. The current version is `3`. | -| `output` | `string` | `interleaved` | Output mode. Available options: `interleaved`, `group` and `prefixed`. | -| `method` | `string` | `checksum` | Default method in this Taskfile. Can be overridden in a task by task basis. Available options: `checksum`, `timestamp` and `none`. | -| `includes` | [`map[string]Include`](#include) | | Additional Taskfiles to be included. | -| `vars` | [`map[string]Variable`](#variable) | | A set of global variables. | -| `env` | [`map[string]Variable`](#variable) | | A set of global environment variables. | -| `tasks` | [`map[string]Task`](#task) | | A set of task definitions. | -| `silent` | `bool` | `false` | Default 'silent' options for this Taskfile. If `false`, can be overridden with `true` in a task by task basis. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `run` | `string` | `always` | Default 'run' option for this Taskfile. Available options: `always`, `once` and `when_changed`. | -| `interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -### Include - -| Attribute | Type | Default | Description | -| ---------- | --------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `taskfile` | `string` | | The path for the Taskfile or directory to be included. If a directory, Task will look for files named `Taskfile.yml` or `Taskfile.yaml` inside that directory. If a relative path, resolved relative to the directory containing the including Taskfile. | -| `dir` | `string` | The parent Taskfile directory | The working directory of the included tasks when run. | -| `optional` | `bool` | `false` | If `true`, no errors will be thrown if the specified file does not exist. | -| `internal` | `bool` | `false` | Stops any task in the included Taskfile from being callable on the command line. These commands will also be omitted from the output when used with `--list`. | -| `aliases` | `[]string` | | Alternative names for the namespace of the included Taskfile. | -| `vars` | `map[string]Variable` | | A set of variables to apply to the included Taskfile. | - -:::info - -Informing only a string like below is equivalent to setting that value to the `taskfile` attribute. - -```yaml -includes: - foo: ./path -``` - -::: - -### Variable - -| Attribute | Type | Default | Description | -| --------- | -------- | ------- | ------------------------------------------------------------------------ | -| _itself_ | `string` | | A static value that will be set to the variable. | -| `sh` | `string` | | A shell command. The output (`STDOUT`) will be assigned to the variable. | - -:::info - -Static and dynamic variables have different syntaxes, like below: - -```yaml -vars: - STATIC: static - DYNAMIC: - sh: echo "dynamic" -``` - -::: - -### Task - -| Attribute | Type | Default | Description | -| --------------- | ---------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmds` | [`[]Command`](#command) | | A list of shell commands to be executed. | -| `deps` | [`[]Dependency`](#dependency) | | A list of dependencies of this task. Tasks defined here will run in parallel before this task. | -| `label` | `string` | | Overrides the name of the task in the output when a task is run. Supports variables. | -| `desc` | `string` | | A short description of the task. This is displayed when calling `task --list`. | -| `prompt` | `string` | | A prompt that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks. | -| `summary` | `string` | | A longer description of the task. This is displayed when calling `task --summary [task]`. | -| `aliases` | `[]string` | | A list of alternative names by which the task can be called. | -| `sources` | `[]string` | | A list of sources to check before running this task. Relevant for `checksum` and `timestamp` methods. Can be file paths or star globs. | -| `generates` | `[]string` | | A list of files meant to be generated by this task. Relevant for `timestamp` method. Can be file paths or star globs. | -| `status` | `[]string` | | A list of commands to check if this task should run. The task is skipped otherwise. This overrides `method`, `sources` and `generates`. | -| `requires` | `[]string` | | A list of variables which should be set if this task is to run, if any of these variables are unset the task will error and not run. | -| `preconditions` | [`[]Precondition`](#precondition) | | A list of commands to check if this task should run. If a condition is not met, the task will error. | -| `requires` | [`Requires`](#requires) | | A list of required variables which should be set if this task is to run, if any variables listed are unset the task will error and not run. | -| `dir` | `string` | | The directory in which this task should run. Defaults to the current working directory. | -| `vars` | [`map[string]Variable`](#variable) | | A set of variables that can be used in the task. | -| `env` | [`map[string]Variable`](#variable) | | A set of environment variables that will be made available to shell commands. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. When combined with the `--list` flag, task descriptions will be hidden. | -| `interactive` | `bool` | `false` | Tells task that the command is interactive. | -| `internal` | `bool` | `false` | Stops a task from being callable on the command line. It will also be omitted from the output when used with `--list`. | -| `method` | `string` | `checksum` | Defines which method is used to check the task is up-to-date. `timestamp` will compare the timestamp of the sources and generates files. `checksum` will check the checksum (You probably want to ignore the .task folder in your .gitignore file). `none` skips any validation and always run the task. | -| `prefix` | `string` | | Defines a string to prefix the output of tasks running in parallel. Only used when the output mode is `prefixed`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing commands. | -| `run` | `string` | The one declared globally in the Taskfile or `always` | Specifies whether the task should run again or not if called more than once. Available options: `always`, `once` and `when_changed`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the task should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Task will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -These alternative syntaxes are available. They will set the given values to `cmds` and everything else will be set to their default values: - -```yaml -tasks: - foo: echo "foo" - - foobar: - - echo "foo" - - echo "bar" - - baz: - cmd: echo "baz" -``` - -::: - -#### Command - -| Attribute | Type | Default | Description | -| -------------- | ---------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmd` | `string` | | The shell command to be executed. | -| `task` | `string` | | Set this to trigger execution of another task instead of running a command. This cannot be set together with `cmd`. | -| `for` | [`For`](#for) | | Runs the command once for each given value. | -| `silent` | `bool` | `false` | Skips some output for this command. Note that STDOUT and STDERR of the commands will still be redirected. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to the referenced task. Only relevant when setting `task` instead of `cmd`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing the command. | -| `defer` | `string` | | Alternative to `cmd`, but schedules the command to be executed at the end of this task instead of immediately. This cannot be used together with `cmd`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the command should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Command will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -If given as a a string, the value will be assigned to `cmd`: - -```yaml -tasks: - foo: - cmds: - - echo "foo" - - echo "bar" -``` - -::: - -#### Dependency - -| Attribute | Type | Default | Description | -| --------- | ---------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------- | -| `task` | `string` | | The task to be execute as a dependency. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to this task. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. | - -:::tip - -If you don't want to set additional variables, it's enough to declare the dependency as a list of strings (they will be assigned to `task`): - -```yaml -tasks: - foo: - deps: [foo, bar] -``` - -::: - -#### For - -The `for` parameter can be defined as a string, a list of strings or a map. If it is defined as a string, you can give it any of the following values: - -- `source` - Will run the command for each source file defined on the task. (Glob patterns will be resolved, so `*.go` will run for every Go file that matches). - -If it is defined as a list of strings, the command will be run for each value. - -Finally, the `for` parameter can be defined as a map when you want to use a variable to define the values to loop over: - -| Attribute | Type | Default | Description | -| --------- | -------- | ---------------- | -------------------------------------------- | -| `var` | `string` | | The name of the variable to use as an input. | -| `split` | `string` | (any whitespace) | What string the variable should be split on. | -| `as` | `string` | `ITEM` | The name of the iterator variable. | - -#### Precondition - -| Attribute | Type | Default | Description | -| --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | -| `sh` | `string` | | Command to be executed. If a non-zero exit code is returned, the task errors without executing its commands. | -| `msg` | `string` | | Optional message to print if the precondition isn't met. | - -:::tip - -If you don't want to set a different message, you can declare a precondition like this and the value will be assigned to `sh`: - -```yaml -tasks: - foo: - precondition: test -f Taskfile.yml -``` - -::: - -#### Requires - -| Attribute | Type | Default | Description | -| --------- | ---------- | ------- | -------------------------------------------------------------------------------------------------- | -| `vars` | `[]string` | | List of variable or environment variable names that must be set if this task is to execute and run | diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/changelog.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/changelog.md deleted file mode 100644 index 628d35e1..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/changelog.md +++ /dev/null @@ -1,573 +0,0 @@ ---- -slug: /changelog/ -sidebar_position: 14 ---- - -# Changelog - -## v3.33.1 - 2023-12-21 - -- Added support for looping over map variables with the [Any Variables experiment](https://taskfile.dev/experiments/any_variables) enabled (#1435, #1437 by @pd93). -- Fixed a bug where dynamic variables were causing errors during fast compilation (#1435, #1437 by @pd93) - -## v3.33.0 - 2023-12-20 - -- Added [Any Variables experiment](https://taskfile.dev/experiments/any-variables) (#1415, #1421 by @pd93). -- Updated Docusaurus to v3 (#1432 by @pd93). -- Added `aliases` to `--json` flag output (#1430, #1431 by @pd93). -- Added new `CLI_FORCE` special variable containing whether the `--force` or `--force-all` flags were set (#1412, #1434 by @pd93). - -## v3.32.0 - 2023-11-29 - -- Added ability to exclude some files from `sources:` by using `exclude:` (#225, - - # 1324 by @pd93 and @andreynering). -- The [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) now prefers remote files over cached ones by default (#1317, #1345 by @pd93). -- Added `--timeout` flag to the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1345 by @pd93). -- Fix bug where dynamic `vars:` and `env:` were being executed when they should actually be skipped by `platforms:` (#1273, #1377 by @andreynering). -- Fix `schema.json` to make `silent` valid in `cmds` that use `for` (#1385, - - # 1386 by @iainvm). -- Add new `--no-status` flag to skip expensive status checks when running `task --list --json` (#1348, #1368 by @amancevice). - -## v3.31.0 - 2023-10-07 - -- Enabled the `--yes` flag for the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1344 by @pd93). -- Add ability to set `watch: true` in a task to automatically run it in watch mode (#231, #1361 by @andreynering). -- Fixed a bug on the watch mode where paths that contained `.git` (like `.github`), for example, were also being ignored (#1356 by @butuzov). -- Fixed a nil pointer error when running a Taskfile with no contents (#1341, - - # 1342 by @pd93). -- Added a new [exit code](https://taskfile.dev/api/#exit-codes) (107) for when a Taskfile does not contain a schema version (#1342 by @pd93). -- Increased limit of maximum task calls from 100 to 1000 for now, as some people have been reaching this limit organically now that we have loops. This check exists to detect recursive calls, but will be removed in favor of a better algorithm soon (#1321, #1332). -- Fixed templating on descriptions on `task --list` (#1343 by @blackjid). -- Fixed a bug where precondition errors were incorrectly being printed when task execution was aborted (#1337, #1338 by @sylv-io). - -## v3.30.1 - 2023-09-14 - -- Fixed a regression where some special variables weren't being set correctly (#1331, #1334 by @pd93). - -## v3.30.0 - 2023-09-13 - -- Prep work for Remote Taskfiles (#1316 by @pd93). -- Added the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) as a draft (#1152, #1317 by @pd93). -- Improve performance of content checksuming on `sources:` by replacing md5 with [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking change because checksums will be invalidated when upgrading to this release (#1325 by @ReillyBrogan). - -## v3.29.1 - 2023-08-26 - -- Update to Go 1.21 (bump minimum version to 1.20) (#1302 by @pd93) -- Fix a missing a line break on log when using `--watch` mode (#1285, #1297 by @FilipSolich). -- Fix `defer` on JSON Schema (#1288 by @calvinmclean and @andreynering). -- Fix bug in usage of special variables like `{{.USER_WORKING_DIR}}` in combination with `includes` (#1046, #1205, #1250, #1293, #1312, #1274 by @andarto, #1309 by @andreynering). -- Fix bug on `--status` flag. Running this flag should not have side-effects: it should not update the checksum on `.task`, only report its status (#1305, - - # 1307 by @visciang, #1313 by @andreynering). - -## v3.28.0 - 2023-07-24 - -- Added the ability to [loop over commands and tasks](https://taskfile.dev/usage/#looping-over-values) using `for` (#82, #1220 by @pd93). -- Fixed variable propagation in multi-level includes (#778, #996, #1256 by @hudclark). -- Fixed a bug where the `--exit-code` code flag was not returning the correct exit code when calling commands indirectly (#1266, #1270 by @pd93). -- Fixed a `nil` panic when a dependency was commented out or left empty (#1263 by @neomantra). - -## v3.27.1 - 2023-06-30 - -- Fix panic when a `.env` directory (not file) is present on current directory (#1244, #1245 by @pd93). - -## v3.27.0 - 2023-06-29 - -- Allow Taskfiles starting with lowercase characters (#947, #1221 by @pd93). - - e.g. `taskfile.yml`, `taskfile.yaml`, `taskfile.dist.yml` & `taskfile.dist.yaml` -- Bug fixes were made to the [npm installation method](https://taskfile.dev/installation/#npm). (#1190, by @sounisi5011). -- Added the [gentle force experiment](https://taskfile.dev/experiments/gentle-force) as a draft (#1200, #1216 by @pd93). -- Added an `--experiments` flag to allow you to see which experiments are enabled (#1242 by @pd93). -- Added ability to specify which variables are required in a task (#1203, #1204 by @benc-uk). - -## v3.26.0 - 2023-06-10 - -- Only rewrite checksum files in `.task` if the checksum has changed (#1185, - - # 1194 by @deviantintegral). -- Added [experiments documentation](https://taskfile.dev/experiments) to the website (#1198 by @pd93). -- Deprecated `version: 2` schema. This will be removed in the next major release (#1197, #1198, #1199 by @pd93). -- Added a new `prompt:` prop to set a warning prompt to be shown before running a potential dangurous task (#100, #1163 by @MaxCheetham, [Documentation](https://taskfile.dev/usage/#warning-prompts)). -- Added support for single command task syntax. With this change, it's now possible to declare just `cmd:` in a task, avoiding the more complex `cmds: []` when you have only a single command for that task (#1130, #1131 by @timdp). - -## v3.25.0 - 2023-05-22 - -- Support `silent:` when calling another tasks (#680, #1142 by @danquah). -- Improve PowerShell completion script (#1168 by @trim21). -- Add more languages to the website menu and show translation progress percentage (#1173 by @misitebao). -- Starting on this release, official binaries for FreeBSD will be available to download (#1068 by @andreynering). -- Fix some errors being unintendedly supressed (#1134 by @clintmod). -- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - - # 1149 by @pd93). -- Fix duplicate error message when a task does not exists (#1141, #1144 by @pd93). - -## v3.24.0 - 2023-04-15 - -- Fix Fish shell completion for tasks with aliases (#1113 by @patricksjackson). -- The default branch was renamed from `master` to `main` (#1049, #1048 by @pd93). -- Fix bug where "up-to-date" logs were not being omitted for silent tasks (#546, - - # 1107 by @danquah). -- Add `.hg` (Mercurial) to the list of ignored directories when using `--watch` (#1098 by @misery). -- More improvements to the release tool (#1096 by @pd93). -- Enforce [gofumpt](https://github.com/mvdan/gofumpt) linter (#1099 by @pd93) -- Add `--sort` flag for use with `--list` and `--list-all` (#946, #1105 by @pd93). -- Task now has [custom exit codes](https://taskfile.dev/api/#exit-codes) depending on the error (#1114 by @pd93). - -## v3.23.0 - 2023-03-26 - -Task now has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task) contributed by @pd93! :tada: The extension is maintained in a [new repository](https://github.com/go-task/vscode-task) under the `go-task` organization. We're looking to gather feedback from the community so please give it a go and let us know what you think via a [discussion](https://github.com/go-task/vscode-task/discussions), [issue](https://github.com/go-task/vscode-task/issues) or on our [Discord](https://discord.gg/6TY36E39UK)! - -> **NOTE:** The extension _requires_ v3.23.0 to be installed in order to work. - -- The website was integrated with [Crowdin](https://crowdin.com/project/taskfile) to allow the community to contribute with translations! [Chinese](https://taskfile.dev/zh-Hans/) is the first language available (#1057, #1058 by @misitebao). -- Added task location data to the `--json` flag output (#1056 by @pd93) -- Change the name of the file generated by `task --init` from `Taskfile.yaml` to `Taskfile.yml` (#1062 by @misitebao). -- Added new `splitArgs` template function (`{{splitArgs "foo bar 'foo bar baz'"}}`) to ensure string is split as arguments (#1040, #1059 by @dhanusaputra). -- Fix the value of `{{.CHECKSUM}}` variable in status (#1076, #1080 by @pd93). -- Fixed deep copy implementation (#1072 by @pd93) -- Created a tool to assist with releases (#1086 by @pd93). - -## v3.22.0 - 2023-03-10 - -- Add a brand new `--global` (`-g`) flag that will run a Taskfile from your `$HOME` directory. This is useful to have automation that you can run from anywhere in your system! ([Documentation](https://taskfile.dev/usage/#running-a-global-taskfile), #1029 by @andreynering). -- Add ability to set `error_only: true` on the `group` output mode. This will instruct Task to only print a command output if it returned with a non-zero exit code (#664, #1022 by @jaedle). -- Fixed bug where `.task/checksum` file was sometimes not being created when task also declares a `status:` (#840, #1035 by @harelwa, #1037 by @pd93). -- Refactored and decoupled fingerprinting from the main Task executor (#1039 by @pd93). -- Fixed deadlock issue when using `run: once` (#715, #1025 by @theunrepentantgeek). - -## v3.21.0 - 2023-02-22 - -- Added new `TASK_VERSION` special variable (#990, #1014 by @ja1code). -- Fixed a bug where tasks were sometimes incorrectly marked as internal (#1007 by @pd93). -- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) -- Added environment variable `FORCE_COLOR` support to force color output. Usefull for environments without TTY (#1003 by @automation-stack) - -## v3.20.0 - 2023-01-14 - -- Improve behavior and performance of status checking when using the `timestamp` mode (#976, #977 by @aminya). -- Performance optimizations were made for large Taskfiles (#982 by @pd93). -- Add ability to configure options for the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins (#908, #929 by @pd93, [Documentation](http://taskfile.dev/usage/#set-and-shopt)). -- Add new `platforms:` attribute to `task` and `cmd`, so it's now possible to choose in which platforms that given task or command will be run on. Possible values are operating system (GOOS), architecture (GOARCH) or a combination of the two. Example: `platforms: [linux]`, `platforms: [amd64]` or `platforms: [linux/amd64]`. Other platforms will be skipped (#978, #980 by @leaanthony). - -## v3.19.1 - 2022-12-31 - -- Small bug fix: closing `Taskfile.yml` once we're done reading it (#963, #964 by @HeCorr). -- Fixes a bug in v2 that caused a panic when using a `Taskfile_{{OS}}.yml` file (#961, #971 by @pd93). -- Fixed a bug where watch intervals set in the Taskfile were not being respected (#969, #970 by @pd93) -- Add `--json` flag (alias `-j`) with the intent to improve support for code editors and add room to other possible integrations. This is basic for now, but we plan to add more info in the near future (#936 by @davidalpert, #764). - -## v3.19.0 - 2022-12-05 - -- Installation via npm now supports [pnpm](https://pnpm.io/) as well ([go-task/go-npm#2](https://github.com/go-task/go-npm/issues/2), [go-task/go-npm#3](https://github.com/go-task/go-npm/pull/3)). -- It's now possible to run Taskfiles from subdirectories! A new `USER_WORKING_DIR` special variable was added to add even more flexibility for monorepos (#289, #920). -- Add task-level `dotenv` support (#389, #904). -- It's now possible to use global level variables on `includes` (#942, #943). -- The website got a brand new [translation to Chinese](https://task-zh.readthedocs.io/zh_CN/latest/) by [@DeronW](https://github.com/DeronW). Thanks! - -## v3.18.0 - 2022-11-12 - -- Show aliases on `task --list --silent` (`task --ls`). This means that aliases will be completed by the completion scripts (#919). -- Tasks in the root Taskfile will now be displayed first in `--list`/`--list-all` output (#806, #890). -- It's now possible to call a `default` task in an included Taskfile by using just the namespace. For example: `docs:default` is now automatically aliased to `docs` (#661, #815). - -## v3.17.0 - 2022-10-14 - -- Add a "Did you mean ...?" suggestion when a task does not exits another one with a similar name is found (#867, #880). -- Now YAML parse errors will print which Taskfile failed to parse (#885, #887). -- Add ability to set `aliases` for tasks and namespaces (#268, #340, #879). -- Improvements to Fish shell completion (#897). -- Added ability to set a different watch interval by setting `interval: '500ms'` or using the `--interval=500ms` flag (#813, #865). -- Add colored output to `--list`, `--list-all` and `--summary` flags (#845, - - # 874). -- Fix unexpected behavior where `label:` was being shown instead of the task name on `--list` (#603, #877). - -## v3.16.0 - 2022-09-29 - -- Add `npm` as new installation method: `npm i -g @go-task/cli` (#870, #871, [npm package](https://www.npmjs.com/package/@go-task/cli)). -- Add support to marking tasks and includes as internal, which will hide them from `--list` and `--list-all` (#818). - -## v3.15.2 - 2022-09-08 - -- Fix error when using variable in `env:` introduced in the previous release (#858, #866). -- Fix handling of `CLI_ARGS` (`--`) in Bash completion (#863). -- On zsh completion, add ability to replace `--list-all` with `--list` as already possible on the Bash completion (#861). - -## v3.15.0 - 2022-09-03 - -- Add new special variables `ROOT_DIR` and `TASKFILE_DIR`. This was a highly requested feature (#215, #857, [Documentation](https://taskfile.dev/api/#special-variables)). -- Follow symlinks on `sources` (#826, #831). -- Improvements and fixes to Bash completion (#835, #844). - -## v3.14.1 - 2022-08-03 - -- Always resolve relative include paths relative to the including Taskfile (#822, #823). -- Fix ZSH and PowerShell completions to consider all tasks instead of just the public ones (those with descriptions) (#803). - -## v3.14.0 - 2022-07-08 - -- Add ability to override the `.task` directory location with the `TASK_TEMP_DIR` environment variable. -- Allow to override Task colors using environment variables: `TASK_COLOR_RESET`, `TASK_COLOR_BLUE`, `TASK_COLOR_GREEN`, `TASK_COLOR_CYAN`, `TASK_COLOR_YELLOW`, `TASK_COLOR_MAGENTA` and `TASK_COLOR_RED` (#568, #792). -- Fixed bug when using the `output: group` mode where STDOUT and STDERR were being print in separated blocks instead of in the right order (#779). -- Starting on this release, ARM architecture binaries are been released to Snap as well (#795). -- i386 binaries won't be available anymore on Snap because Ubuntu removed the support for this architecture. -- Upgrade mvdan.cc/sh, which fixes a bug with associative arrays (#785, [mvdan/sh#884](https://github.com/mvdan/sh/issues/884), [mvdan/sh#893](https://github.com/mvdan/sh/pull/893)). - -## v3.13.0 - 2022-06-13 - -- Added `-n` as an alias to `--dry` (#776, #777). -- Fix behavior of interrupt (SIGINT, SIGTERM) signals. Task will now give time for the processes running to do cleanup work (#458, #479, #728, #769). -- Add new `--exit-code` (`-x`) flag that will pass-through the exit form the command being ran (#755). - -## v3.12.1 - 2022-05-10 - -- Fixed bug where, on Windows, variables were ending with `\r` because we were only removing the final `\n` but not `\r\n` (#717). - -## v3.12.0 - 2022-03-31 - -- The `--list` and `--list-all` flags can now be combined with the `--silent` flag to print the task names only, without their description (#691). -- Added support for multi-level inclusion of Taskfiles. This means that included Taskfiles can also include other Taskfiles. Before this was limited to one level (#390, #623, #656). -- Add ability to specify vars when including a Taskfile. [Check out the documentation](https://taskfile.dev/#/usage?id=vars-of-included-taskfiles) for more information (#677). - -## v3.11.0 - 2022-02-19 - -- Task now supports printing begin and end messages when using the `group` output mode, useful for grouping tasks in CI systems. [Check out the documentation](http://taskfile.dev/#/usage?id=output-syntax) for more information (#647, #651). -- Add `Taskfile.dist.yml` and `Taskfile.dist.yaml` to the supported file name list. [Check out the documentation](https://taskfile.dev/#/usage?id=supported-file-names) for more information (#498, #666). - -## v3.10.0 - 2022-01-04 - -- A new `--list-all` (alias `-a`) flag is now available. It's similar to the exiting `--list` (`-l`) but prints all tasks, even those without a description (#383, #401). -- It's now possible to schedule cleanup commands to run once a task finishes with the `defer:` keyword ([Documentation](https://taskfile.dev/#/usage?id=doing-task-cleanup-with-defer), - - # 475, #626). -- Remove long deprecated and undocumented `$` variable prefix and `^` command prefix (#642, #644, #645). -- Add support for `.yaml` extension (as an alternative to `.yml`). This was requested multiple times throughout the years. Enjoy! (#183, #184, #369, #584, - - # 621). -- Fixed error when computing a variable when the task directory do not exist yet (#481, #579). - -## v3.9.2 - 2021-12-02 - -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains a fix a for a important regression on Windows (#619, [mvdan/sh#768](https://github.com/mvdan/sh/issues/768), [mvdan/sh#769](https://github.com/mvdan/sh/pull/769)). - -## v3.9.1 - 2021-11-28 - -- Add logging in verbose mode for when a task starts and finishes (#533, #588). -- Fix an issue with preconditions and context errors (#597, #598). -- Quote each `{{.CLI_ARGS}}` argument to prevent one with spaces to become many (#613). -- Fix nil pointer when `cmd:` was left empty (#612, #614). -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains two relevant fixes: - - Fix quote of empty strings in `shellQuote` (#609, [mvdan/sh#763](https://github.com/mvdan/sh/issues/763)). - - Fix issue of wrong environment variable being picked when there's another very similar one (#586, [mvdan/sh#745](https://github.com/mvdan/sh/pull/745)). -- Install shell completions automatically when installing via Homebrew (#264, #592, [go-task/homebrew-tap#2](https://github.com/go-task/homebrew-tap/pull/2)). - -## v3.9.0 - 2021-10-02 - -- A new `shellQuote` function was added to the template system (`{{shellQuote "a string"}}`) to ensure a string is safe for use in shell ([mvdan/sh#727](https://github.com/mvdan/sh/pull/727), [mvdan/sh#737](https://github.com/mvdan/sh/pull/737), [Documentation](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)) -- In this version [mvdan.cc/sh](https://github.com/mvdan/sh) was upgraded with some small fixes and features - - The `read -p` flag is now supported (#314, [mvdan/sh#551](https://github.com/mvdan/sh/issues/551), [mvdan/sh#772](https://github.com/mvdan/sh/pull/722)) - - The `pwd -P` and `pwd -L` flags are now supported (#553, [mvdan/sh#724](https://github.com/mvdan/sh/issues/724), [mvdan/sh#728](https://github.com/mvdan/sh/pull/728)) - - The `$GID` environment variable is now correctly being set (#561, [mvdan/sh#723](https://github.com/mvdan/sh/pull/723)) - -## v3.8.0 - 2021-09-26 - -- Add `interactive: true` setting to improve support for interactive CLI apps (#217, #563). -- Fix some `nil` errors (#534, #573). -- Add ability to declare an included Taskfile as optional (#519, #552). -- Add support for including Taskfiles in the home directory by using `~` (#539, #557). - -## v3.7.3 - 2021-09-04 - -- Add official support to Apple M1 (#564, #567). -- Our [official Homebrew tap](https://github.com/go-task/homebrew-tap) will support more platforms, including Apple M1 - -## v3.7.0 - 2021-07-31 - -- Add `run:` setting to control if tasks should run multiple times or not. Available options are `always` (the default), `when_changed` (if a variable modified the task) and `once` (run only once no matter what). This is a long time requested feature. Enjoy! (#53, #359). - -## v3.6.0 - 2021-07-10 - -- Allow using both `sources:` and `status:` in the same task (#411, #427, #477). -- Small optimization and bug fix: don't compute variables if not needed for `dotenv:` (#517). - -## v3.5.0 - 2021-07-04 - -- Add support for interpolation in `dotenv:` (#433, #434, #453). - -## v3.4.3 - 2021-05-30 - -- Add support for the `NO_COLOR` environment variable. (#459, [fatih/color#137](https://github.com/fatih/color/pull/137)). -- Fix bug where sources were not considering the right directory in `--watch` mode (#484, #485). - -## v3.4.2 - 2021-04-23 - -- On watch, report which file failed to read (#472). -- Do not try to catch SIGKILL signal, which are not actually possible (#476). -- Improve version reporting when building Task from source using Go Modules (#462, #473). - -## v3.4.1 - 2021-04-17 - -- Improve error reporting when parsing YAML: in some situations where you would just see an generic error, you'll now see the actual error with more detail: the YAML line the failed to parse, for example (#467). -- A JSON Schema was published [here](https://json.schemastore.org/taskfile.json) and is automatically being used by some editors like Visual Studio Code (#135). -- Print task name before the command in the log output (#398). - -## v3.3.0 - 2021-03-20 - -- Add support for delegating CLI arguments to commands with `--` and a special `CLI_ARGS` variable (#327). -- Add a `--concurrency` (alias `-C`) flag, to limit the number of tasks that run concurrently. This is useful for heavy workloads. (#345). - -## v3.2.2 - 2021-01-12 - -- Improve performance of `--list` and `--summary` by skipping running shell variables for these flags (#332). -- Fixed a bug where an environment in a Taskfile was not always overridable by the system environment (#425). -- Fixed environment from .env files not being available as variables (#379). -- The install script is now working for ARM platforms (#428). - -## v3.2.1 - 2021-01-09 - -- Fixed some bugs and regressions regarding dynamic variables and directories (#426). -- The [slim-sprig](https://github.com/go-task/slim-sprig) package was updated with the upstream [sprig](https://github.com/Masterminds/sprig). - -## v3.2.0 - 2021-01-07 - -- Fix the `.task` directory being created in the task directory instead of the Taskfile directory (#247). -- Fix a bug where dynamic variables (those declared with `sh:`) were not running in the task directory when the task has a custom dir or it was in an included Taskfile (#384). -- The watch feature (via the `--watch` flag) got a few different bug fixes and should be more stable now (#423, #365). - -## v3.1.0 - 2021-01-03 - -- Fix a bug when the checksum up-to-date resolution is used by a task with a custom `label:` attribute (#412). -- Starting from this release, we're releasing official ARMv6 and ARM64 binaries for Linux (#375, #418). -- Task now respects the order of declaration of included Taskfiles when evaluating variables declaring by them (#393). -- `set -e` is now automatically set on every command. This was done to fix an issue where multiline string commands wouldn't really fail unless the sentence was in the last line (#403). - -## v3.0.1 - 2020-12-26 - -- Allow use as a library by moving the required packages out of the `internal` directory (#358). -- Do not error if a specified dotenv file does not exist (#378, #385). -- Fix panic when you have empty tasks in your Taskfile (#338, #362). - -## v3.0.0 - 2020-08-16 - -- On `v3`, all CLI variables will be considered global variables (#336, #341) -- Add support to `.env` like files (#324, #356). -- Add `label:` to task so you can override the task name in the logs (#321, - - # 337). -- Refactor how variables work on version 3 (#311). -- Disallow `expansions` on v3 since it has no effect. -- `Taskvars.yml` is not automatically included anymore. -- `Taskfile_{{OS}}.yml` is not automatically included anymore. -- Allow interpolation on `includes`, so you can manually include a Taskfile based on operation system, for example. -- Expose `.TASK` variable in templates with the task name (#252). -- Implement short task syntax (#194, #240). -- Added option to make included Taskfile run commands on its own directory (#260, #144) -- Taskfiles in version 1 are not supported anymore (#237). -- Added global `method:` option. With this option, you can set a default method to all tasks in a Taskfile (#246). -- Changed default method from `timestamp` to `checksum` (#246). -- New magic variables are now available when using `status:`: `.TIMESTAMP` which contains the greatest modification date from the files listed in `sources:`, and `.CHECKSUM`, which contains a checksum of all files listed in `status:`. This is useful for manual checking when using external, or even remote, artifacts when using `status:` (#216). -- We're now using [slim-sprig](https://github.com/go-task/slim-sprig) instead of [sprig](https://github.com/Masterminds/sprig), which allowed a file size reduction of about 22% (#219). -- We now use some colors on Task output to better distinguish message types - commands are green, errors are red, etc (#207). - -## v2.8.1 - 2020-05-20 - -- Fix error code for the `--help` flag (#300, #330). -- Print version to stdout instead of stderr (#299, #329). -- Supress `context` errors when using the `--watch` flag (#313, #317). -- Support templating on description (#276, #283). - -## v2.8.0 - 2019-12-07 - -- Add `--parallel` flag (alias `-p`) to run tasks given by the command line in parallel (#266). -- Fixed bug where calling the `task` CLI only informing global vars would not execute the `default` task. -- Add hability to silent all tasks by adding `silent: true` a the root of the Taskfile. - -## v2.7.1 - 2019-11-10 - -- Fix error being raised when `exit 0` was called (#251). - -## v2.7.0 - 2019-09-22 - -- Fixed panic bug when assigning a global variable (#229, #243). -- A task with `method: checksum` will now re-run if generated files are deleted (#228, #238). - -## v2.6.0 - 2019-07-21 - -- Fixed some bugs regarding minor version checks on `version:`. -- Add `preconditions:` to task (#205). -- Create directory informed on `dir:` if it doesn't exist (#209, #211). -- We now have a `--taskfile` flag (alias `-t`), which can be used to run another Taskfile (other than the default `Taskfile.yml`) (#221). -- It's now possible to install Task using Homebrew on Linux ([go-task/homebrew-tap#1](https://github.com/go-task/homebrew-tap/pull/1)). - -## v2.5.2 - 2019-05-11 - -- Reverted YAML upgrade due issues with CRLF on Windows (#201, [go-yaml/yaml#450](https://github.com/go-yaml/yaml/issues/450)). -- Allow setting global variables through the CLI (#192). - -## 2.5.1 - 2019-04-27 - -- Fixed some issues with interactive command line tools, where sometimes the output were not being shown, and similar issues (#114, #190, #200). -- Upgraded [go-yaml/yaml](https://github.com/go-yaml/yaml) from v2 to v3. - -## v2.5.0 - 2019-03-16 - -- We moved from the taskfile.org domain to the new fancy taskfile.dev domain. While stuff is being redirected, we strongly recommend to everyone that use [this install script](https://taskfile.dev/#/installation?id=install-script) to use the new taskfile.dev domain on scripts from now on. -- Fixed to the ZSH completion (#182). -- Add [`--summary` flag along with `summary:` task attribute](https://taskfile.org/#/usage?id=display-summary-of-task) (#180). - -## v2.4.0 - 2019-02-21 - -- Allow calling a task of the root Taskfile from an included Taskfile by prefixing it with `:` (#161, #172). -- Add flag to override the `output` option (#173). -- Fix bug where Task was persisting the new checksum on the disk when the Dry Mode is enabled (#166). -- Fix file timestamp issue when the file name has spaces (#176). -- Mitigating path expanding issues on Windows (#170). - -## v2.3.0 - 2019-01-02 - -- On Windows, Task can now be installed using [Scoop](https://scoop.sh/) (#152). -- Fixed issue with file/directory globing (#153). -- Added ability to globally set environment variables (#138, #159). - -## v2.2.1 - 2018-12-09 - -- This repository now uses Go Modules (#143). We'll still keep the `vendor` directory in sync for some time, though; -- Fixing a bug when the Taskfile has no tasks but includes another Taskfile (#150); -- Fix a bug when calling another task or a dependency in an included Taskfile (#151). - -## v2.2.0 - 2018-10-25 - -- Added support for [including other Taskfiles](https://taskfile.org/#/usage?id=including-other-taskfiles) (#98) - - This should be considered experimental. For now, only including local files is supported, but support for including remote Taskfiles is being discussed. If you have any feedback, please comment on #98. -- Task now have a dedicated documentation site: https://taskfile.org - - Thanks to [Docsify](https://docsify.js.org/) for making this pretty easy. To check the source code, just take a look at the [docs](https://github.com/go-task/task/tree/main/docs) directory of this repository. Contributions to the documentation is really appreciated. - -## v2.1.1 - 2018-09-17 - -- Fix suggestion to use `task --init` not being shown anymore (when a `Taskfile.yml` is not found) -- Fix error when using checksum method and no file exists for a source glob (#131) -- Fix signal handling when the `--watch` flag is given (#132) - -## v2.1.0 - 2018-08-19 - -- Add a `ignore_error` option to task and command (#123) -- Add a dry run mode (`--dry` flag) (#126) - -## v2.0.3 - 2018-06-24 - -- Expand environment variables on "dir", "sources" and "generates" (#116) -- Fix YAML merging syntax (#112) -- Add ZSH completion (#111) -- Implement new `output` option. Please check out the [documentation](https://github.com/go-task/task#output-syntax) - -## v2.0.2 - 2018-05-01 - -- Fix merging of YAML anchors (#112) - -## v2.0.1 - 2018-03-11 - -- Fixes panic on `task --list` - -## v2.0.0 - 2018-03-08 - -Version 2.0.0 is here, with a new Taskfile format. - -Please, make sure to read the [Taskfile versions](https://github.com/go-task/task/blob/main/TASKFILE_VERSIONS.md) document, since it describes in depth what changed for this version. - -- New Taskfile version 2 (#77) -- Possibility to have global variables in the `Taskfile.yml` instead of `Taskvars.yml` (#66) -- Small improvements and fixes - -## v1.4.4 - 2017-11-19 - -- Handle SIGINT and SIGTERM (#75); -- List: print message with there's no task with description; -- Expand home dir ("~" symbol) on paths (#74); -- Add Snap as an installation method; -- Move examples to its own repo; -- Watch: also walk on tasks called on on "cmds", and not only on "deps"; -- Print logs to stderr instead of stdout (#68); -- Remove deprecated `set` keyword; -- Add checksum based status check, alternative to timestamp based. - -## v1.4.3 - 2017-09-07 - -- Allow assigning variables to tasks at run time via CLI (#33) -- Added suport for multiline variables from sh (#64) -- Fixes env: remove square braces and evaluate shell (#62) -- Watch: change watch library and few fixes and improvements -- When use watching, cancel and restart long running process on file change (#59 and #60) - -## v1.4.2 - 2017-07-30 - -- Flag to set directory of execution -- Always echo command if is verbose mode -- Add silent mode to disable echoing of commands -- Fixes and improvements of variables (#56) - -## v1.4.1 - 2017-07-15 - -- Allow use of YAML for dynamic variables instead of $ prefix - - `VAR: {sh: echo Hello}` instead of `VAR: $echo Hello` -- Add `--list` (or `-l`) flag to print existing tasks -- OS specific Taskvars file (e.g. `Taskvars_windows.yml`, `Taskvars_linux.yml`, etc) -- Consider task up-to-date on equal timestamps (#49) -- Allow absolute path in generates section (#48) -- Bugfix: allow templating when calling deps (#42) -- Fix panic for invalid task in cyclic dep detection -- Better error output for dynamic variables in Taskvars.yml (#41) -- Allow template evaluation in parameters - -## v1.4.0 - 2017-07-06 - -- Cache dynamic variables -- Add verbose mode (`-v` flag) -- Support to task parameters (overriding vars) (#31) (#32) -- Print command, also when "set:" is specified (#35) -- Improve task command help text (#35) - -## v1.3.1 - 2017-06-14 - -- Fix glob not working on commands (#28) -- Add ExeExt template function -- Add `--init` flag to create a new Taskfile -- Add status option to prevent task from running (#27) -- Allow interpolation on `generates` and `sources` attributes (#26) - -## v1.3.0 - 2017-04-24 - -- Migrate from os/exec.Cmd to a native Go sh/bash interpreter - - This is a potentially breaking change if you use Windows. - - Now, `cmd` is not used anymore on Windows. Always use Bash-like syntax for your commands, even on Windows. -- Add "ToSlash" and "FromSlash" to template functions -- Use functions defined on github.com/Masterminds/sprig -- Do not redirect stdin while running variables commands -- Using `context` and `errgroup` packages (this will make other tasks to be cancelled, if one returned an error) - -## v1.2.0 - 2017-04-02 - -- More tests and Travis integration -- Watch a task (experimental) -- Possibility to call another task -- Fix "=" not being reconized in variables/environment variables -- Tasks can now have a description, and help will print them (#10) -- Task dependencies now run concurrently -- Support for a default task (#16) - -## v1.1.0 - 2017-03-08 - -- Support for YAML, TOML and JSON (#1) -- Support running command in another directory (#4) -- `--force` or `-f` flag to force execution of task even when it's up-to-date -- Detection of cyclic dependencies (#5) -- Support for variables (#6, #9, #14) -- Operation System specific commands and variables (#13) - -## v1.0.0 - 2017-02-28 - -- Add LICENSE file diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/community.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/community.md deleted file mode 100644 index 4946d681..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/community.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -slug: /community/ -sidebar_position: 9 ---- - -# Communauté - -Certains travaux d'amélioration de l'écosystème Task sont réalisés par la communauté, que ce soit des méthodes d'installation ou des intégrations avec l'éditeur de code. Moi (l'auteur) suis reconnaissant envers tout le monde qui m'aide à améliorer l'expérience globale. - -## Traductions - -Nous utilisons [Crowdin](https://crowdin.com/project/taskfile) pour traduire nos documents. - -## Intégrations - -Un grand nombre de nos intégrations sont apportées et maintenues par la communauté. Vous pouvez voir la liste complète des intégrations de la communauté [ici](/integrations#community-integrations). - -## Méthodes d'installation - -Certaines méthodes d'installation sont maintenues par un tiers : - -- [GitHub Actions](https://github.com/arduino/setup-task) by @arduino -- [AUR](https://aur.archlinux.org/packages/go-task-bin) by @carlsmedstad -- [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json) -- [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) -- [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/go-task/default.nix) -- [Conda](https://github.com/conda-forge/go-task-feedstock/) - -## Plus d’infos - -Aussi, merci à tous les [contributeurs](https://github.com/go-task/task/graphs/contributors), [contributeurs financiers](https://opencollective.com/task), tous ceux qui [ont signalé des bugs](https://github.com/go-task/task/issues?q=is%3Aissue) et [ont répondu aux questions](https://github.com/go-task/task/discussions). - -Si vous voyez quelque chose qui manque dans ce document, veuillez soumettre une pull request. diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/contributing.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/contributing.md deleted file mode 100644 index 57b2aa7b..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/contributing.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -slug: /contributing/ -sidebar_position: 11 ---- - -# Contributing - -Contributions to Task are very welcome, but we ask that you read this document before submitting a PR. - -:::note - -This document applies to the core [Task][task] repository _and_ [Task for Visual Studio Code][vscode-task]. - -::: - -## Before you start - -- **Check existing work** - Is there an existing PR? Are there issues discussing the feature/change you want to make? Please make sure you consider/address these discussions in your work. -- **Backwards compatibility** - Will your change break existing Taskfiles? It is much more likely that your change will merged if it backwards compatible. Is there an approach you can take that maintains this compatibility? If not, consider opening an issue first so that API changes can be discussed before you invest your time into a PR. -- **Experiments** - If there is no way to make your change backward compatible then there is a procedure to introduce breaking changes into minor versions. We call these "\[experiments\]\[experiments\]". If you're intending to work on an experiment, then please read the \[experiments workflow\]\[experiments-workflow\] document carefully and submit a proposal first. - -## 1. Setup - -- **Go** - Task is written in [Go][go]. We always support the latest two major Go versions, so make sure your version is recent enough. -- **Node.js** - [Node.js][nodejs] is used to host Task's documentation server and is required if you want to run this server locally. It is also required if you want to contribute to the Visual Studio Code extension. -- **Yarn** - [Yarn][yarn] is the Node.js package manager used by Task. - -## 2. Making changes - -- **Code style** - Try to maintain the existing code style where possible. Go code should be formatted by [`gofumpt`][gofumpt] and linted using [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be formatted and linted by [Prettier][prettier]. This style is enforced by our CI to ensure that we have a consistent style across the project. You can use the `task lint` command to lint the code locally and the `task lint:fix` command to automatically fix any issues that are found. -- **Documentation** - Ensure that you add/update any relevant documentation. See the [updating documentation](#updating-documentation) section below. -- **Tests** - Ensure that you add/update any relevant tests and that all tests are passing before submitting the PR. See the [writing tests](#writing-tests) section below. - -### Running your changes - -To run Task with working changes, you can use `go run ./cmd/task`. To run a development build of task against a test Taskfile in `testdata`, you can use `go run ./cmd/task --dir ./testdata/ `. - -To run Task for Visual Studio Code, you can open the project in VSCode and hit F5 (or whatever you debug keybind is set to). This will open a new VSCode window with the extension running. Debugging this way is recommended as it will allow you to set breakpoints and step through the code. Otherwise, you can run `task package` which will generate a `.vsix` file that can be used to manually install the extension. - -### Updating documentation - -Task uses [Docusaurus][docusaurus] to host a documentation server. The code for this is located in the core Task repository. This can be setup and run locally by using `task docs` (requires `nodejs` & `yarn`). All content is written in Markdown and is located in the `docs/docs` directory. All Markdown documents should have an 80 character line wrap limit (enforced by Prettier). - -When making a change, consider whether a change to the [Usage Guide](/usage) is necessary. This document contains descriptions and examples of how to use Task features. If you're adding a new feature, try to find an appropriate place to add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](/styleguide). - -If you added a new field, command or flag, ensure that you add it to the [API Reference](/api). New fields also need to be added to the [JSON Schema][json-schema]. The descriptions for fields in the API reference and the schema should match. - -### Writing tests - -A lot of Task's tests are held in the `task_test.go` file in the project root and this is where you'll most likely want to add new ones too. Most of these tests also have a subdirectory in the `testdata` directory where any Taskfiles/data required to run the tests are stored. - -When making a changes, consider whether new tests are required. These tests should ensure that the functionality you are adding will continue to work in the future. Existing tests may also need updating if you have changed Task's behavior. - -You may also consider adding unit tests for any new functions you have added. The unit tests should follow the Go convention of being location in a file named `*_test.go` in the same package as the code being tested. - -## 3. Committing your code - -Try to write meaningful commit messages and avoid having too many commits on the PR. Most PRs should likely have a single commit (although for bigger PRs it may be reasonable to split it in a few). Git squash and rebase is your friend! - -If you're not sure how to format your commit message, check out [Conventional Commits][conventional-commits]. This style is not enforced, but it is a good way to make your commit messages more readable and consistent. - -## 4. Submitting a PR - -- **Describe your changes** - Ensure that you provide a comprehensive description of your changes. -- **Issue/PR links** - Link any previous work such as related issues or PRs. Please describe how your changes differ to/extend this work. -- **Examples** - Add any examples or screenshots that you think are useful to demonstrate the effect of your changes. -- **Draft PRs** - If your changes are incomplete, but you would like to discuss them, open the PR as a draft and add a comment to start a discussion. Using comments rather than the PR description allows the description to be updated later while preserving any discussions. - -## FAQ - -> I want to contribute, where do I start? - -Take a look at the list of [open issues for Task][task-open-issues] or [Task for Visual Studio Code][vscode-task-open-issues]. We have a [good first issue][good-first-issue] label for simpler issues that are ideal for first time contributions. - -All kinds of contributions are welcome, whether its a typo fix or a shiny new feature. You can also contribute by upvoting/commenting on issues, helping to answer questions or contributing to other [community projects](/community). - -> I'm stuck, where can I get help? - -If you have questions, feel free to ask them in the `#help` forum channel on our [Discord server][discord-server] or open a [Discussion][discussion] on GitHub. - ---- - - - - -[task]: https://github.com/go-task/task -[vscode-task]: https://github.com/go-task/vscode-task -[go]: https://go.dev -[gofumpt]: https://github.com/mvdan/gofumpt -[golangci-lint]: https://golangci-lint.run -[prettier]: https://prettier.io -[nodejs]: https://nodejs.org/en/ -[yarn]: https://yarnpkg.com/ -[docusaurus]: https://docusaurus.io -[json-schema]: https://github.com/go-task/task/blob/main/docs/static/schema.json -[task-open-issues]: https://github.com/go-task/task/issues -[vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues -[good-first-issue]: https://github.com/go-task/task/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 -[discord-server]: https://discord.gg/6TY36E39UK -[discussion]: https://github.com/go-task/task/discussions -[conventional-commits]: https://www.conventionalcommits.org diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/deprecations/deprecations.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/deprecations/deprecations.md deleted file mode 100644 index ab3d2353..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/deprecations/deprecations.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: /deprecations/ -sidebar_position: 7 ---- - -# Dépréciations - -Au fur et à mesure que Task évolue, certaines de ses fonctionnalités peuvent se montrer obsolètes. Cela peut être dû au fait qu'elles ne sont plus utiles, parce qu'une autre fonctionnalité l'a remplacée ou à cause d'un changement dans la façon dont la tâche fonctionne. - -Lorsque cela se produit, nous marquons la fonctionnalité comme obsolète. Cela signifie que sera supprimé dans une future version de Task. La fonctionnalité continuera de fonctionner en attendant, mais il vous est fortement recommandé de ne plus l'utiliser et de planifier un plan de migration pour changer toutes les tâches pouvant l'utiliser. - -Vous pouvez afficher une liste complète des dépréciations actives dans la section "Dépréciations" de la barre latérale. diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/deprecations/template.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/deprecations/template.md deleted file mode 100644 index 646e45c6..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/deprecations/template.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Deprecated Feature\} (#\{Issue\}) - -:::warning - -This deprecation breaks the following functionality: - -- \{list any existing functionality that will be broken by this deprecation\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -\{Short description of the feature/behavior and why it is being deprecated\} - -\{Short explanation of any replacement features/behaviors and how users should migrate to it\} diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md deleted file mode 100644 index c45fb65d..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -slug: /deprecations/version-2-schema/ ---- - -# Version 2 Schema (#1197) - -:::warning - -This deprecation breaks the following functionality: - -- Any Taskfiles that use the version 2 schema -- `Taskvar.yml` files - -::: - -The Taskfile version 2 schema was introduced in March 2018 and replaced by version 3 in August 2019. In May 2023 [we published a deprecation notice][deprecation-notice] for the version 2 schema on the basis that the vast majority of users had already upgraded to version 3 and removing support for version 2 would allow us to tidy up the codebase and focus on new functionality instead. - -In December 2023, the final version of Task that supports the version 2 schema ([v3.33.0][v3.33.0]) was published and all legacy code was removed from Task's main branch. To use a more recent version of Task, you will need to ensure that your Taskfile uses the version 3 schema instead. A list of changes between version 2 and version 3 are available in the [Task v3 Release Notes][v3.0.0]. - - - - -[v3.0.0]: https://github.com/go-task/task/releases/tag/v3.0.0 -[v3.33.0]: https://github.com/go-task/task/releases/tag/v3.33.0 -[deprecation-notice]: https://github.com/go-task/task/issues/1197 diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/donate.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/donate.md deleted file mode 100644 index 278ec516..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/donate.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: /donate/ -sidebar_position: 16 ---- - -# Faire un don - -Si vous trouvez ce projet utile, vous pouvez envisager de faire un don en utilisant l'un des canaux listés ci-dessous. - -C'est juste une façon de nous dire "merci", il ne vous donnera pas d'avantages comme une priorité élevée sur des problèmes ou des choses similaires. - -Les entreprises qui font un don d'au moins 50$/mois seront présentées comme un "Sponsor Or" sur la page d'accueil du site and sur le README du dépôt GitHub. Prenez contact avec [@andreynering][] avec le logo que vous voulez afficher. Cependant, les entreprises suspectes (jeux, casinos, etc) ne seront pas autorisées. - -## Sponsors GitHub - -La façon préférée de faire un don aux mainteneurs du projet est d'utiliser les sponsors GitHub. Vous pouvez utiliser le lien suivant pour faire votre don. We suggest a 50/50 split to each maintainer of the total amount you plan to donate to the project. - -- [@andreynering](https://github.com/sponsors/andreynering) -- [@pd93](https://github.com/sponsors/pd93) - -## Open Collective - -Si vous préférez [Open Collective](https://opencollective.com/task) vous pouvez faire un don en utilisant ces liens : - -- [2$ par mois](https://opencollective.com/task/contribute/backer-4034/checkout) -- [5$ par mois](https://opencollective.com/task/contribute/supporter-8404/checkout) -- [20$ par mois](https://opencollective.com/task/contribute/sponsor-4035/checkout) -- [50$ par mois](https://opencollective.com/task/contribute/sponsor-28775/checkout) -- [Valeur personnalisée - option de don unique prise en charge](https://opencollective.com/task/donate) - -## PayPal - -Vous pouvez aussi faire un don à [@andreynering][] via PayPal : - -- [N'importe quelle valeur - Don unique](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GSVDU63RKG45A¤cy_code=USD&source=url) - -## PIX (Brésil uniquement) - -Et si vous êtes Brésilien, vous pouvez également faire un don à [@andreynering][] via PIX en [utilisant ce QR Code](/img/pix.png). - - - - -[@andreynering]: https://github.com/andreynering diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/any_variables.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/any_variables.md deleted file mode 100644 index cf2521c7..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/any_variables.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables (#1415) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any -time_. We strongly recommend that you do not use these features in a production -environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- Dynamically defined variables (using the `sh` keyword) - -::: - -:::info - -To enable this experiment, set the environment variable: -`TASK_X_ANY_VARIABLES=1`. Check out [our guide to enabling experiments -][enabling-experiments] for more information. - -::: - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the [slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for "collection-type" variables, the `for` -keyword has been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -This also works for maps. When looping over a map we also make an additional -`{{.KEY}}` variable availabe that holds the string value of the map key. -Remember that maps are unordered, so the order in which the items are looped -over is random: - -```yaml -version: 3 - -tasks: - foo: - vars: - MAP: - KEY_1: - SUBKEY: sub_value_1 - KEY_2: - SUBKEY: sub_value_2 - KEY_3: - SUBKEY: sub_value_3 - cmds: - - for: - var: MAP - cmd: echo {{.KEY}} {{.ITEM.SUBKEY}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[enabling-experiments]: /experiments/#enabling-experiments - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx deleted file mode 100644 index 73cdcd80..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables - -- Issue: #1415 -- Environment variable: `TASK_X_ANY_VARIABLES=1` -- Breaks: - - Dynamically defined variables (using the `sh` keyword) - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the -[slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for array variables, the `for` keyword has -been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/experiments.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/experiments.md deleted file mode 100644 index 1a15dbd7..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/experiments.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -slug: /experiments/ -sidebar_position: 6 ---- - -# Expérimentations - -:::caution - -Toutes les fonctionnalités expérimentales sont sujettes à des changements brisant la fonctionnalité et/ou à la suppression de cette dernière _à tout moment _. Nous vous recommandons fortement de ne pas utiliser ces fonctionnalités dans en production. Ils sont seulement destinés à être testés et obtenir des retours dessus. - -::: - -Afin de permettre à Task d'évoluer rapidement, nous déployons des changements cassants sur des versions mineures activables par des options expérimentales. Cela nous permet d'obtenir des retours sur des changements brisants des fonctionnalités avant de les livrer dans une version majeure. Ce document décrit l'ensemble actuel de fonctionnalités expérimentales et leur statut dans le [workflow](#workflow). - -Vous pouvez consulter une liste complète des expérimentations en cours dans la section "Expérimentations" de la barre latérale . - -## Enabling Experiments - -You can enable an experimental feature by doing one of the following: - -1. Utiliser la variable d'environnement pertinente devant une commande Task. Par exemple, `TASK_X_{FEATURE}=1 task {my-task}`. Ceci est prévu pour faire appel à une expérimentation durant une seule commande Task afin de tester une fonctionnalité expérimentale. -1. Utiliser la variable d'environnement pertinente dans vos "dotfiles" (par exemple `.bashrc`, `.zshrc` etc.). Ceci est destiné à l'activation permanente des fonctionnalités expérimentales dans votre environnement. -1. Création d'un fichier `.env` dans le même répertoire que votre fichier Taskfile contenant les variables d'environnement pertinentes pour vos tests. This allows you to enable an experimental feature at a project level. For example: - -```shell title=".env" -TASK_X_FEATURE=1 -``` - -## Current Experimental Features and Deprecations - -Each section below details an experiment or deprecation and explains what the flags/environment variables to enable the experiment are and how the feature's behavior will change. It will also explain what you need to do to migrate any existing Taskfiles to the new behavior. - -## Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -### 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -### 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -### 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -### 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -### 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -### Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/gentle_force.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/gentle_force.md deleted file mode 100644 index 514602bb..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/gentle_force.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -slug: /experiments/gentle-force/ ---- - -# Gentle Force (#1200) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- The `--force` flag - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_FORCE=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -The `--force` flag currently forces _all_ tasks to run regardless of the status checks. This can be useful, but we have found that most of the time users only expect the direct task they are calling to be forced and _not_ all of its dependant tasks. - -This experiment changes the `--force` flag to only force the directly called task. All dependant tasks will have their statuses checked as normal and will only run if Task considers them to be out of date. A new `--force-all` flag will also be added to maintain the current behavior for users that need this functionality. - -If you want to migrate, but continue to force all dependant tasks to run, you should replace all uses of the `--force` flag with `--force-all`. Alternatively, if you want to adopt the new behavior, you can continue to use the `--force` flag as you do now! - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md deleted file mode 100644 index 73a934d8..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -slug: /experiments/remote-taskfiles/ ---- - -# Remote Taskfiles (#1317) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_REMOTE_TASKFILES=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -This experiment allows you to specify a remote Taskfile URL when including a Taskfile. For example: - -```yaml -version: '3' - -includes: - my-remote-namespace: https://raw.githubusercontent.com/my-org/my-repo/main/Taskfile.yml -``` - -This works exactly the same way that including a local file does. Any tasks in the remote Taskfile will be available to run from your main Taskfile via the namespace `my-remote-namespace`. For example, if the remote file contains the following: - -```yaml -version: '3' - -tasks: - hello: - silent: true - cmds: - - echo "Hello from the remote Taskfile!" -``` - -and you run `task my-remote-namespace:hello`, it will print the text: "Hello from the remote Taskfile!" to your console. - -## Security - -Running commands from sources that you do not control is always a potential security risk. For this reason, we have added some checks when using remote Taskfiles: - -1. When running a task from a remote Taskfile for the first time, Task will print a warning to the console asking you to check that you are sure that you trust the source of the Taskfile. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the remote Taskfile will run and further calls to the remote Taskfile will not prompt you again. -2. Whenever you run a remote Taskfile, Task will create and store a checksum of the file that you are running. If the checksum changes, then Task will print another warning to the console to inform you that the contents of the remote file has changed. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the checksum will be updated and the remote Taskfile will run. - -Sometimes you need to run Task in an environment that does not have an interactive terminal, so you are not able to accept a prompt. In these cases you are able to tell task to accept these prompts automatically by using the `--yes` flag. Before enabling this flag, you should: - -1. Be sure that you trust the source and contents of the remote Taskfile. -2. Consider using a pinned version of the remote Taskfile (e.g. A link containing a commit hash) to prevent Task from automatically accepting a prompt that says a remote Taskfile has changed. - -Task currently supports both `http` and `https` URLs. However, the `http` requests will not execute by default unless you run the task with the `--insecure` flag. This is to protect you from accidentally running a remote Taskfile that is hosted on and unencrypted connection. Sources that are not protected by TLS are vulnerable to [man-in-the-middle attacks][man-in-the-middle-attacks] and should be avoided unless you know what you are doing. - -## Caching & Running Offline - -Whenever you run a remote Taskfile, the latest copy will be downloaded from the internet and cached locally. If for whatever reason, you lose access to the internet, you will still be able to run your tasks by specifying the `--offline` flag. This will tell Task to use the latest cached version of the file instead of trying to download it. You are able to use the `--download` flag to update the cached version of the remote files without running any tasks. - -By default, Task will timeout requests to download remote files after 10 seconds and look for a cached copy instead. This timeout can be configured by setting the `--timeout` flag and specifying a duration. For example, `--timeout 5s` will set the timeout to 5 seconds. - - - - -[enabling-experiments]: /experiments/#enabling-experiments -[man-in-the-middle-attacks]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/template.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/template.md deleted file mode 100644 index 59246cf5..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/template.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Experiment\} (#\{Issue\}) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- \{list any existing functionality that will be broken by this experiment\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_{feature}=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -\{Short description of the feature\} - -\{Short explanation of how users should migrate to the new behavior\} - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/workflow.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/workflow.md deleted file mode 100644 index 62aff616..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/experiments/workflow.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /experiments/workflow/ ---- - -# Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -## 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -## 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -## 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -## 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -## 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -## Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/faq.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/faq.md deleted file mode 100644 index d3033bf2..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/faq.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -slug: /faq/ -sidebar_position: 15 ---- - -# FAQ - -Cette page contient une liste de question fréquemment posée à propos de Task. - -## Why won't my task update my shell environment? - -This is a limitation of how shells work. Task runs as a subprocess of your current shell, so it can't change the environment of the shell that started it. This limitation is shared by other task runners and build tools too. - -A common way to work around this is to create a task that will generate output that can be parsed by your shell. For example, to set an environment variable on your shell you can write a task like this: - -```yaml -my-shell-env: - cmds: - - echo "export FOO=foo" - - echo "export BAR=bar" -``` - -Now run `eval $(task my-shell-env)` and the variables `$FOO` and `$BAR` will be available in your shell. - -## I can't reuse my shell in a task's commands - -Task runs each command as a separate shell process, so something you do in one command won't effect any future commands. For example, this won't work: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - a=foo - - echo $a - # outputs "" -``` - -To work around this you can either use a multiline command: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - | - a=foo - echo $a - # outputs "foo" -``` - -Or for more complex multi-line commands it is recommended to move your code into a separate file and call that instead: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - ./foo-printer.bash -``` - -```bash -#!/bin/bash -a=foo -echo $a -``` - -## 'x' builtin command doesn't work on Windows - -The default shell on Windows (`cmd` and `powershell`) do not have commands like `rm` and `cp` available as builtins. This means that these commands won't work. If you want to make your Taskfile fully cross-platform, you'll need to work around this limitation using one of the following methods: - -- Use the `{{OS}}` function to run an OS-specific script. -- Use something like `{{if eq OS "windows"}}powershell {{end}}` to detect windows and run the command in Powershell directly. -- Use a shell on Windows that supports these commands as builtins, such as [Git Bash][git-bash] or [WSL][wsl]. - -We want to make improvements to this part of Task and the issues below track this work. Constructive comments and contributions are very welcome! - -- #197 -- [mvdan/sh#93](https://github.com/mvdan/sh/issues/93) -- [mvdan/sh#97](https://github.com/mvdan/sh/issues/97) - - - - -[git-bash]: https://gitforwindows.org/ -[wsl]: https://learn.microsoft.com/en-us/windows/wsl/install diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/installation.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/installation.md deleted file mode 100644 index 5b4d48eb..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/installation.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -slug: /installation/ -sidebar_position: 2 ---- - -# Installation - -Task offers many installation methods. Check out the available methods below. - -## Package Managers - -### Homebrew - -If you're on macOS or Linux and have [Homebrew][homebrew] installed, getting Task is as simple as running: - -```bash -brew install go-task/tap/go-task -``` - -The above Formula is [maintained by ourselves](https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb). - -Recently, Task was also made available [on the official Homebrew repository](https://formulae.brew.sh/formula/go-task), so you also have that option if you prefer: - -```bash -brew install go-task -``` - -### Tea - -If you're on macOS or Linux and have [tea][tea] installed, getting Task is as simple as running: - -```bash -tea task -``` - -or, if you have tea’s magic enabled: - -```bash -task -``` -This installation method is community owned. After a new release of Task, they are automatically released by tea in a minimum of time. - -### Snap - -Task is available in [Snapcraft][snapcraft], but keep in mind that your Linux distribution should allow classic confinement for Snaps to Task work right: - -```bash -sudo snap install task --classic -``` - -### Chocolatey - -If you're on Windows and have [Chocolatey][choco] installed, getting Task is as simple as running: - -```bash -choco install go-task -``` - -This installation method is community owned. - -### Scoop - -If you're on Windows and have [Scoop][scoop] installed, getting Task is as simple as running: - -```cmd -scoop install task -``` - -This installation method is community owned. After a new release of Task, it may take some time until it's available on Scoop. - -### AUR - -If you're on Arch Linux you can install Task from [AUR](https://aur.archlinux.org/packages/go-task-bin) using your favorite package manager such as `yay`, `pacaur` or `yaourt`: - -```cmd -yay -S go-task-bin -``` - -Alternatively, there's [this package](https://aur.archlinux.org/packages/go-task) which installs from the source code instead of downloading the binary from the [releases page](https://github.com/go-task/task/releases): - -```cmd -yay -S go-task -``` - -This installation method is community owned. - -### Fedora - -If you're on Fedora Linux you can install Task from the official [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) repository using `dnf`: - -```cmd -sudo dnf install go-task -``` - -This installation method is community owned. After a new release of Task, it may take some time until it's available in [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/). - -### Nix - -If you're on NixOS or have Nix installed you can install Task from [nixpkgs](https://github.com/NixOS/nixpkgs): - -```cmd -nix-env -iA nixpkgs.go-task -``` - -This installation method is community owned. After a new release of Task, it may take some time until it's available in [nixpkgs](https://github.com/NixOS/nixpkgs). - -### npm - -You can also use Node and npm to install Task by installing [this package](https://www.npmjs.com/package/@go-task/cli). - -```bash -npm install -g @go-task/cli -``` - -### Winget - -If you are using Windows and installed the [winget](https://github.com/microsoft/winget-cli) package management tool, you can install Task from [winget-pkgs](https://github.com/microsoft/winget-pkgs). - -```bash -winget install Task.Task -``` - -## Get The Binary - -### Binary - -You can download the binary from the [releases page on GitHub][releases] and add to your `$PATH`. - -DEB and RPM packages are also available. - -The `task_checksums.txt` file contains the SHA-256 checksum for each file. - -### Install Script - -We also have an [install script][installscript] which is very useful in scenarios like CI. Many thanks to [GoDownloader][godownloader] for enabling the easy generation of this script. - -By default, it installs on the `./bin` directory relative to the working directory: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -``` - -It is possible to override the installation directory with the `-b` parameter. On Linux, common choices are `~/.local/bin` and `~/bin` to install for the current user or `/usr/local/bin` to install for all users: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin -``` - -:::caution - -On macOS and Windows, `~/.local/bin` and `~/bin` are not added to `$PATH` by default. - -::: - -### GitHub Actions - -If you want to install Task in GitHub Actions you can try using [this action](https://github.com/arduino/setup-task) by the Arduino team: - -```yaml -- name: Install Task - uses: arduino/setup-task@v1 - with: - version: 3.x - repo-token: ${{ secrets.GITHUB_TOKEN }} -``` - -This installation method is community owned. - -## Build From Source - -### Go Modules - -Ensure that you have a supported version of [Go][go] properly installed and setup. You can find the minimum required version of Go in the [go.mod](https://github.com/go-task/task/blob/main/go.mod#L3) file. - -You can then install the latest release globally by running: - -```bash -go install github.com/go-task/task/v3/cmd/task@latest -``` - -Or you can install into another directory: - -```bash -env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest -``` - -:::tip - -For CI environments we recommend using the [install script](#install-script) instead, which is faster and more stable, since it'll just download the latest released binary. - -::: - -## Setup completions - -Download the autocompletion file corresponding to your shell. - -[All completions are available on the Task repository](https://github.com/go-task/task/tree/main/completion). - -### Bash - -First, ensure that you installed bash-completion using your package manager. - -Make the completion file executable: - -``` -chmod +x path/to/task.bash -``` - -After, add this to your `~/.bash_profile`: - -```shell -source path/to/task.bash -``` - -### ZSH - -Put the `_task` file somewhere in your `$FPATH`: - -```shell -mv path/to/_task /usr/local/share/zsh/site-functions/_task -``` - -Ensure that the following is present in your `~/.zshrc`: - -```shell -autoload -U compinit -compinit -i -``` - -ZSH version 5.7 or later is recommended. - -### Fish - -Move the `task.fish` completion script: - -```shell -mv path/to/task.fish ~/.config/fish/completions/task.fish -``` - -### PowerShell - -Open your profile script with: - -``` -mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue -notepad $profile -``` - -Add the line and save the file: - -```shell -Invoke-Expression -Command path/to/task.ps1 -``` - - - - -[go]: https://golang.org/ -[snapcraft]: https://snapcraft.io/task -[homebrew]: https://brew.sh/ -[installscript]: https://github.com/go-task/task/blob/main/install-task.sh -[releases]: https://github.com/go-task/task/releases -[godownloader]: https://github.com/goreleaser/godownloader -[choco]: https://chocolatey.org/ -[scoop]: https://scoop.sh/ -[tea]: https://tea.xyz/ diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/integrations.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/integrations.md deleted file mode 100644 index b6e4c800..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/integrations.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -slug: /integrations/ -sidebar_position: 8 ---- - -# Integrations - -## Visual Studio Code Extension - -Task has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task). The code for this project can be found [here](https://github.com/go-task/vscode-task). To use this extension, you must have Task v3.23.0+ installed on your system. - -This extension provides the following features (and more): - -- View tasks in the sidebar. -- Run tasks from the sidebar and command palette. -- Go to definition from the sidebar and command palette. -- Run last task command. -- Multi-root workspace support. -- Initialize a Taskfile in the current workspace. - -To get autocompletion and validation for your Taskfile, see the [Schema](#schema) section below. - -![Task for Visual Studio Code](https://github.com/go-task/vscode-task/blob/main/res/preview.png?raw=true) - -## Schema - -This was initially created by @KROSF in [this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and is now officially maintained in [this file](https://github.com/go-task/task/blob/main/docs/static/schema.json) and made available at https://taskfile.dev/schema.json. This schema can be used to validate Taskfiles and provide autocompletion in many code editors: - -### Visual Studio Code - -To integrate the schema into VS Code, you need to install the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) by Red Hat. Any `Taskfile.yml` in your project should automatically be detected and validation/autocompletion should work. If this doesn't work or you want to manually configure it for files with a different name, you can add the following to your `settings.json`: - -```json -// settings.json -{ - "yaml.schemas": { - "https://taskfile.dev/schema.json": [ - "**/Taskfile.yml", - "./path/to/any/other/taskfile.yml" - ] - } -} -``` - -You can also configure the schema directly inside of a Taskfile by adding the following comment to the top of the file: - -```yaml -# yaml-language-server: $schema=https://taskfile.dev/schema.json -version: '3' -``` - -You can find more information on this in the [YAML language server project](https://github.com/redhat-developer/yaml-language-server). - -## Community Integrations - -In addition to our official integrations, there is an amazing community of developers who have created their own integrations for Task: - -- [Sublime Text Plugin](https://packagecontrol.io/packages/Taskfile) [[source](https://github.com/biozz/sublime-taskfile)] by @biozz -- [IntelliJ Plugin](https://plugins.jetbrains.com/plugin/17058-taskfile) [[source](https://github.com/lechuckroh/task-intellij-plugin)] by @lechuckroh -- [mk](https://github.com/pycontribs/mk) command line tool recognizes Taskfiles natively. - -If you have made something that integrates with Task, please feel free to open a PR to add it to this list. diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/intro.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/intro.md deleted file mode 100644 index e5228263..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/intro.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -slug: / -sidebar_position: 1 -title: Accueil ---- - -# Task - -
- -
- -Task est un exécuteur de tâches / de build qui vise à être plus simple et facile à utiliser que, par exemple, [GNU Make][make]. - -Comme il est écrit en [Go][go], Task n'est qu'un binaire unique et n'a aucune dépendance. Cela signifie que vous n'avez pas besoin d'une installation compliquée simplement pour utiliser un outil de build. - -Once [installed](/installation), you just need to describe your build tasks using a simple [YAML][yaml] schema in a file called `Taskfile.yml`: - -```yaml title="Taskfile.yml" -version: '3' - -tasks: - hello: - cmds: - - echo 'Hello World from Task!' - silent: true -``` - -Et appelez-le en exécutant `task hello` depuis votre terminal. - -L'exemple ci-dessus n'est que le début, vous pouvez jeter un coup d'œil au [guide d'utilisation](/usage) pour vérifier la documentation complète du schéma et les fonctionnalités de Task. - -## Fonctionnalités - -- [Easy installation](/installation): just download a single binary, add to `$PATH` and you're done! Ou vous pouvez également installer en utilisant [Homebrew][homebrew], [Snapcraft][snapcraft] ou [Scoop][scoop] si vous le souhaitez. -- Available on CIs: by adding [this simple command](/installation#install-script) to install on your CI script and you're ready to use Task as part of your CI pipeline; -- Multi-plateforme : alors que la plupart des outils de compilation ne fonctionnent bien que sous Linux ou macOS, Task prend également en charge Windows grâce à [cet interpréteur shell pour Go][sh]. -- Idéal pour la génération de code : vous pouvez facilement [empêcher une tâche de s'exécuter](/usage#prevent-unnecessary-work) si un ensemble donné de fichiers n'ont pas changé depuis le dernier lancement (basé soit sur son horodatage soit son contenu). - - - - -[make]: https://www.gnu.org/software/make/ -[go]: https://go.dev/ -[yaml]: http://yaml.org/ -[homebrew]: https://brew.sh/ -[snapcraft]: https://snapcraft.io/ -[scoop]: https://scoop.sh/ -[sh]: https://github.com/mvdan/sh diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/releasing.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/releasing.md deleted file mode 100644 index b232b322..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/releasing.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /releasing/ -sidebar_position: 13 ---- - -# Releasing - -The release process of Task is done with the help of [GoReleaser][goreleaser]. You can test the release process locally by calling the `test-release` task of the Taskfile. - -[GitHub Actions](https://github.com/go-task/task/actions) should release artifacts automatically when a new Git tag is pushed to `main` branch (raw executables and DEB and RPM packages). - -Since v3.15.0, raw executables can also be reproduced and verified locally by checking out a specific tag and calling `goreleaser build`, using the Go version defined in the above GitHub Actions. - -# Homebrew - -Goreleaser will automatically push a new commit to the [Formula/go-task.rb][gotaskrb] file in the [Homebrew tap][homebrewtap] repository to release the new version. - -# npm - -To release to npm update the version in the [`package.json`][packagejson] file and then run `task npm:publish` to push it. - -# Snapcraft - -The [snap package][snappackage] requires to manual steps to release a new version: - -- Updating the current version on [snapcraft.yaml][snapcraftyaml]. -- Moving both `amd64`, `armhf` and `arm64` new artifacts to the stable channel on the [Snapcraft dashboard][snapcraftdashboard]. - -# winget - -winget also requires manual steps to be completed. By running `task goreleaser:test` locally, manifest files will be generated on `dist/winget/manifests/t/Task/Task/v{version}`. [Upload the manifest directory into this fork](https://github.com/go-task/winget-pkgs/tree/master/manifests/t/Task/Task) and open a pull request into [this repository](https://github.com/microsoft/winget-pkgs). - -# Scoop - -Scoop is a command-line package manager for the Windows operating system. Scoop package manifests are maintained by the community. Scoop owners usually take care of updating versions there by editing [this file](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json). If you think its Task version is outdated, open an issue to let us know. - -# Nix - -Nix is a community owned installation method. Nix package maintainers usually take care of updating versions there by editing [this file](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/development/tools/go-task/default.nix). If you think its Task version is outdated, open an issue to let us know. - - - - -[goreleaser]: https://goreleaser.com/ -[homebrewtap]: https://github.com/go-task/homebrew-tap -[gotaskrb]: https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb -[packagejson]: https://github.com/go-task/task/blob/main/package.json#L3 -[snappackage]: https://github.com/go-task/snap -[snapcraftyaml]: https://github.com/go-task/snap/blob/main/snap/snapcraft.yaml#L2 -[snapcraftdashboard]: https://snapcraft.io/task/releases diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/styleguide.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/styleguide.md deleted file mode 100644 index e1ee6016..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/styleguide.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -slug: /styleguide/ -sidebar_position: 10 ---- - -# Guide de style - -Ceci est le guide officiel du style Task pour les fichiers `Taskfile.yml`. Ce guide contient quelques instructions de base pour garder votre Taskfile propre et familier à autres utilisateurs. - -Il contient des directives générales, mais elles ne doivent pas nécessairement être strictement respectées. N'hésitez pas à procéder différemment si vous en avez le besoin ou que vous le souhaitez. Aussi, n'hésitez pas à [ouvrir une issue](https://github. com/go-task/task/issues/new/choose) ou [faire une pull request](https://github. com/go-task/task/compare) pour améliorer ce guide. - -## Utiliser les mots-clés dans l'ordre correct - -- `version:` -- `includes:` -- Configuration ones, like `output:`, `silent:`, `method:` and `run:` -- `vars:` -- `env:`, `dotenv:` -- `tasks:` - -## Utiliser 2 espaces pour l'indentation - -C'est la convention la plus courante pour les fichiers YAML et Task suit cette convention. - -```yaml -# bad -tasks: - foo: - cmds: - - echo 'foo' - - -# good -tasks: - foo: - cmds: - - echo 'foo' -``` - -## Séparer les sections principales avec un retour à la ligne - -```yaml -# bad -version: '3' -includes: - docker: ./docker/Taskfile.yml -output: prefixed -vars: - FOO: bar -env: - BAR: baz -tasks: - # ... - - -# good -version: '3' - -includes: - docker: ./docker/Taskfile.yml - -output: prefixed - -vars: - FOO: bar - -env: - BAR: baz - -tasks: - # ... -``` - -## Ajouter des retours à la ligne entre les tâches - -```yaml -# bad -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - bar: - cmds: - - echo 'bar' - baz: - cmds: - - echo 'baz' - - -# good -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - - bar: - cmds: - - echo 'bar' - - baz: - cmds: - - echo 'baz' -``` - -## Utiliser des noms de variables en majuscule - -```yaml -# bad -version: '3' - -vars: - binary_name: myapp - -tasks: - build: - cmds: - - go build -o {{.binary_name}} . - - -# good -version: '3' - -vars: - BINARY_NAME: myapp - -tasks: - build: - cmds: - - go build -o {{.BINARY_NAME}} . -``` - -## Ne pas mettre d'espaces autour des variables lors de l'utilisation - -```yaml -# bad -version: '3' - -tasks: - greet: - cmds: - - echo '{{ .MESSAGE }}' - - -# good -version: '3' - -tasks: - greet: - cmds: - - echo '{{.MESSAGE}}' -``` - -Cette convention est aussi utilisée par la plupart des gens pour n'importe quel modèle Go. - -## Séparer les mots du nom de la tâche par un tiret - -```yaml -# bad -version: '3' - -tasks: - do_something_fancy: - cmds: - - echo 'Do something' - - -# good -version: '3' - -tasks: - do-something-fancy: - cmds: - - echo 'Do something' -``` - -## Utiliser les deux-points pour nommer les namespaces de tâche - -```yaml -# good -version: '3' - -tasks: - docker:build: - cmds: - - docker ... - - docker:run: - cmds: - - docker-compose ... -``` - -C'est aussi fait automatiquement quand vous incluez des Taskfiles. - -## Préférer les scripts externes à des commandes complexes à plusieurs lignes - -```yaml -# Incorrect -version: '3' - -tasks: - build: - cmds: - - | - for i in $(seq 1 10); do - echo $i - echo "some other complex logic" - done' - -# Correct -version: '3' - -tasks: - build: - cmds: - - ./scripts/my_complex_script.sh -``` diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/taskfile_versions.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/taskfile_versions.md deleted file mode 100644 index cf920ace..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/taskfile_versions.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -slug: /taskfile-versions/ -sidebar_position: 5 ---- - -# Versions Taskfile - -La syntaxe et les fonctionnalités du fichier Taskfile changent avec le temps. Ce document explique quels sont les changments pour chacune des versions et comment vous pouvez mettre à jour votre Taskfile. - -## Qu'est-ce que la version de Taskfile signifie - -La version de Taskfile suit la version de Task. Par exemple : Le changement pour la version `2` dans Taskfile signifie que la version `v2.0.0` de Task doit être publiée pour pouvoir le supporter. - -Le paramètrre `version:` dans Taskfile accepte une version suivant la nomenclature semver. Donc `2`, `2.0` et `2.0.0` sont acceptés. Si vous choisissez d'utiliser la version `2.0`, Task ne va pas activer les fonctionnalités des versions `2.1` et celles d'après. Mais si vous choississez d'utiliser la version `2`, alors toutes les fonctionnalités des versions `2.x.x` seront disponibles, et non celles des versions `3.0.0` et celles d'après. - -## Version 3 ![Dernier](https://img.shields.io/badge/latest-brightgreen) - -Voici quelques modifications majeures effectuées sur `v3`: - -- Les logs de Task dans le terminal sont colorés -- Ajout du support des fichiers `.env` et similaires -- Ajout du paramètre `label:` dans les tâches pour que l'on puisse renommer la tâche dans les logs -- Le paramètre global `method:` a été ajouté pour permettre de définir la méthode par défault, et la valeur par défaut de Task a été changée pour `checksum` -- Deux variables magiques ont été ajoutées lors de l'utilisation de `status:`: `CHECKSUM` et `TIMESTAMP` qui contiennent respectivement le checksum XXH3 et le plus récent timestamp de modification des fichiers répertoriés dans `sources:` -- Aussi, la variable `TASK` est toujours disponible avec le nom de la tâche courante -- Les variables CLI sont toujours traitées comme des variables globales -- Ajout de l'option `dir:` dans `includes` pour permettre de choisir dans quel dossier un Taskfile doit être exécuté : - -```yaml -includes: - docs: - taskfile: ./docs - dir: ./docs -``` - -- Implémentation de syntaxes courtes. Toutes les syntaxes ci-dessous sont équivalentes: - -```yaml -version: '3' - -tasks: - print: - cmds: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: echo "Hello, World!" -``` - -- Il y a eu une réécriture majeure sur la manière dont les variables sont gérées. C'est maintenant plus simple à comprendre. Les paramètres `expansions:` ont été retirées vu qu'ils n'étaient plus nécessaires. C'est l'ordre dans lequel Task va traiter les variables, chaque niveau peut voir les variables définies par la précédente et les remplacer. - - Variables d'environnement - - Variables globales + CLI - - Variables d'appel - - Variables Task - -## Version 2.6 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -La version 2.6 vient avec des `preconditions` dans les tâches. - -```yaml -version: '2' - -tasks: - upload_environment: - preconditions: - - test -f .env - cmds: - - aws s3 cp .env s3://myenvironment -``` - -Please check the [documentation][includes] - -## Version 2.2 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -La version 2.2 est fournie avec une option globale `includes` pour inclure d'autres Taskfiles : - -```yaml -version: '2' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -## Version 2.1 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.1 includes a global `output` option, to allow having more control over how commands output are printed to the console (see [documentation][output] for more info): - -```yaml -version: '2' - -output: prefixed - -tasks: - server: - cmds: - - go run main.go - prefix: server -``` - -From this version it's also possible to ignore errors of a command or task (check documentation [here][ignore_errors]): - -```yaml -version: '2' - -tasks: - example-1: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "This will be print" - - example-2: - cmds: - - exit 1 - - echo "This will be print" - ignore_error: true -``` - -## Version 2.0 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -À la version 2, nous avons introduit le paramètre `version:` pour nous permettre d'évoluer vers de nouvelles fonctionnalités avec sans casser les fichiers de tâches existants. La nouvelle syntaxe est la suivante: - -```yaml -version: '2' - -tasks: - echo: - cmds: - - echo "Hello, World!" -``` - -La version 2 vous permet d'écrire des variables globales directement dans le fichier Taskfile, si vous ne voulez pas créer un fichier `Taskvars.yml`: - -```yaml -version: '2' - -vars: - GREETING: Hello, World! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -A présent, l'ordre de priorité des variables est : - -1. Variables Task -2. Variables d'appel -3. Variables Taskfile -4. Variables du fichier Taskvars -5. Variables d'environnement - -Une nouvelle option globale a été ajoutée pour configurer le nombre d'extensions de variables (par défaut 2): - -```yaml -version: '2' - -expansions: 3 - -vars: - FOO: foo - BAR: bar - BAZ: baz - FOOBAR: '{{.FOO}}{{.BAR}}' - FOOBARBAZ: '{{.FOOBAR}}{{.BAZ}}' - -tasks: - default: - cmds: - - echo "{{.FOOBARBAZ}}" -``` - -## Version 1 - -:::caution - -Le support du schéma v1 a été supprimé de Task >= v3.0.0. - -::: - -Dans la première version du `Taskfile`, le champ `version:` n'était pas disponible, parce que les tâches étaient à la racine du document YAML. Comme ceci: - -```yaml -echo: - cmds: - - echo "Hello, World!" -``` - -L'ordre de priorité de la variable était également différent : - -1. Variables d'appel -2. Variables d'environnement -3. Variables Task -4. Variables `Taskvars.yml` - - - - -[deprecate-version-2-schema]: /deprecations/version-2-schema/ -[output]: /usage#output-syntax -[ignore_errors]: /usage#ignore-errors -[includes]: /usage#including-other-taskfiles diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/translate.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/translate.md deleted file mode 100644 index a0cf5125..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/translate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -slug: /translate/ -sidebar_position: 12 ---- - -# Traduction - -Vous voulez nous aider à traduire cette documentation ? Nous expliquons ci-dessous comment faire. - -Ne PAS éditer directement sur le dépôt GitHub les fichiers markdown traduits ! Nous utilisons [Crowdin][crowdin] pour permettre aux contributeurs de travailler sur les traductions. Le dépôt est périodiquement mis à jour avec la progression des traductions sur Crowdin. - -Si vous voulez avoir accès au projet Crowdin pour pouvoir suggérer des traductions, veuillez demander l'accès sur le [canal #traductions sur notre serveur Discord ][discord]. Si une langue n'est pas encore affichée sur Crowdin, il suffit de demander et nous pouvons la configurer. - - - - -[crowdin]: https://crowdin.com/project/taskfile -[discord]: https://discord.gg/6TY36E39UK diff --git a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/usage.md b/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/usage.md deleted file mode 100644 index 0691dc63..00000000 --- a/docs/i18n/fr-FR/docusaurus-plugin-content-docs/current/usage.md +++ /dev/null @@ -1,1624 +0,0 @@ ---- -slug: /usage/ -sidebar_position: 3 ---- - -# Usage - -## Getting started - -Create a file called `Taskfile.yml` in the root of your project. The `cmds` attribute should contain the commands of a task. The example below allows compiling a Go app and uses [esbuild](https://esbuild.github.io/) to concat and minify multiple CSS files into a single one. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -Running the tasks is as simple as running: - -```bash -task assets build -``` - -Task uses [mvdan.cc/sh](https://mvdan.cc/sh/), a native Go sh interpreter. So you can write sh/bash commands, and it will work even on Windows, where `sh` or `bash` are usually not available. Just remember any executable called must be available by the OS or in PATH. - -If you omit a task name, "default" will be assumed. - -## Supported file names - -Task will look for the following file names, in order of priority: - -- Taskfile.yml -- taskfile.yml -- Taskfile.yaml -- taskfile.yaml -- Taskfile.dist.yml -- taskfile.dist.yml -- Taskfile.dist.yaml -- taskfile.dist.yaml - -The intention of having the `.dist` variants is to allow projects to have one committed version (`.dist`) while still allowing individual users to override the Taskfile by adding an additional `Taskfile.yml` (which would be on `.gitignore`). - -### Running a Taskfile from a subdirectory - -If a Taskfile cannot be found in the current working directory, it will walk up the file tree until it finds one (similar to how `git` works). When running Task from a subdirectory like this, it will behave as if you ran it from the directory containing the Taskfile. - -You can use this functionality along with the special `{{.USER_WORKING_DIR}}` variable to create some very useful reusable tasks. For example, if you have a monorepo with directories for each microservice, you can `cd` into a microservice directory and run a task command to bring it up without having to create multiple tasks or Taskfiles with identical content. For example: - -```yaml -version: '3' - -tasks: - up: - dir: '{{.USER_WORKING_DIR}}' - preconditions: - - test -f docker-compose.yml - cmds: - - docker-compose up -d -``` - -In this example, we can run `cd ` and `task up` and as long as the `` directory contains a `docker-compose.yml`, the Docker composition will be brought up. - -### Running a global Taskfile - -If you call Task with the `--global` (alias `-g`) flag, it will look for your home directory instead of your working directory. In short, Task will look for a Taskfile that matches `$HOME/{T,t}askfile.{yml,yaml}` . - -This is useful to have automation that you can run from anywhere in your system! - -:::info - -When running your global Taskfile with `-g`, tasks will run on `$HOME` by default, and not on your working directory! - -As mentioned in the previous section, the `{{.USER_WORKING_DIR}}` special variable can be very handy here to run stuff on the directory you're calling `task -g` from. - -```yaml -version: '3' - -tasks: - from-home: - cmds: - - pwd - - from-working-directory: - dir: '{{.USER_WORKING_DIR}}' - cmds: - - pwd -``` - -::: - -## Environment variables - -### Task - -You can use `env` to set custom environment variables for a specific task: - -```yaml -version: '3' - -tasks: - greet: - cmds: - - echo $GREETING - env: - GREETING: Hey, there! -``` - -Additionally, you can set global environment variables that will be available to all tasks: - -```yaml -version: '3' - -env: - GREETING: Hey, there! - -tasks: - greet: - cmds: - - echo $GREETING -``` - -:::info - -`env` supports expansion and retrieving output from a shell command just like variables, as you can see in the [Variables](#variables) section. - -::: - -### .env files - -You can also ask Task to include `.env` like files by using the `dotenv:` setting: - -```bash title=".env" -KEYNAME=VALUE -``` - -```bash title="testing/.env" -ENDPOINT=testing.com -``` - -```yaml title="Taskfile.yml" -version: '3' - -env: - ENV: testing - -dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - -tasks: - greet: - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Dotenv files can also be specified at the task level: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Environment variables specified explicitly at the task-level will override variables defined in dotfiles: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - env: - KEYNAME: DIFFERENT_VALUE - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -:::info - -Please note that you are not currently able to use the `dotenv` key inside included Taskfiles. - -::: - -## Including other Taskfiles - -If you want to share tasks between different projects (Taskfiles), you can use the importing mechanism to include other Taskfiles using the `includes` keyword: - -```yaml -version: '3' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -The tasks described in the given Taskfiles will be available with the informed namespace. So, you'd call `task docs:serve` to run the `serve` task from `documentation/Taskfile.yml` or `task docker:build` to run the `build` task from the `DockerTasks.yml` file. - -Relative paths are resolved relative to the directory containing the including Taskfile. - -### OS-specific Taskfiles - -With `version: '2'`, task automatically includes any `Taskfile_{{OS}}.yml` if it exists (for example: `Taskfile_windows.yml`, `Taskfile_linux.yml` or `Taskfile_darwin.yml`). Since this behavior was a bit too implicit, it was removed on version 3, but you still can have a similar behavior by explicitly importing these files: - -```yaml -version: '3' - -includes: - build: ./Taskfile_{{OS}}.yml -``` - -### Directory of included Taskfile - -By default, included Taskfile's tasks are run in the current directory, even if the Taskfile is in another directory, but you can force its tasks to run in another directory by using this alternative syntax: - -```yaml -version: '3' - -includes: - docs: - taskfile: ./docs/Taskfile.yml - dir: ./docs -``` - -:::info - -The included Taskfiles must be using the same schema version as the main Taskfile uses. - -::: - -### Optional includes - -Includes marked as optional will allow Task to continue execution as normal if the included file is missing. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./tests/Taskfile.yml - optional: true - -tasks: - greet: - cmds: - - echo "This command can still be successfully executed if - ./tests/Taskfile.yml does not exist" -``` - -### Internal includes - -Includes marked as internal will set all the tasks of the included file to be internal as well (see the [Internal tasks](#internal-tasks) section below). This is useful when including utility tasks that are not intended to be used directly by the user. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./taskfiles/Utils.yml - internal: true -``` - -### Vars of included Taskfiles - -You can also specify variables when including a Taskfile. This may be useful for having reusable Taskfile that can be tweaked or even included more than once: - -```yaml -version: '3' - -includes: - backend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: backend_image - - frontend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: frontend_image -``` - -### Namespace aliases - -When including a Taskfile, you can give the namespace a list of `aliases`. This works in the same way as [task aliases](#task-aliases) and can be used together to create shorter and easier-to-type commands. - -```yaml -version: '3' - -includes: - generate: - taskfile: ./taskfiles/Generate.yml - aliases: [gen] -``` - -:::info - -Vars declared in the included Taskfile have preference over the variables in the including Taskfile! If you want a variable in an included Taskfile to be overridable, use the [default function](https://go-task.github.io/slim-sprig/defaults.html): `MY_VAR: '{{.MY_VAR | default "my-default-value"}}'`. - -::: - -## Internal tasks - -Internal tasks are tasks that cannot be called directly by the user. They will not appear in the output when running `task --list|--list-all`. Other tasks may call internal tasks in the usual way. This is useful for creating reusable, function-like tasks that have no useful purpose on the command line. - -```yaml -version: '3' - -tasks: - build-image-1: - cmds: - - task: build-image - vars: - DOCKER_IMAGE: image-1 - - build-image: - internal: true - cmds: - - docker build -t {{.DOCKER_IMAGE}} . -``` - -## Task directory - -By default, tasks will be executed in the directory where the Taskfile is located. But you can easily make the task run in another folder, informing `dir`: - -```yaml -version: '3' - -tasks: - serve: - dir: public/www - cmds: - # run http server - - caddy -``` - -If the directory does not exist, `task` creates it. - -## Task dependencies - -> Dependencies run in parallel, so dependencies of a task should not depend one another. If you want to force tasks to run serially, take a look at the [Calling Another Task](#calling-another-task) section below. - -You may have tasks that depend on others. Just pointing them on `deps` will make them run automatically before running the parent task: - -```yaml -version: '3' - -tasks: - build: - deps: [assets] - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -In the above example, `assets` will always run right before `build` if you run `task build`. - -A task can have only dependencies and no commands to group tasks together: - -```yaml -version: '3' - -tasks: - assets: - deps: [js, css] - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -If there is more than one dependency, they always run in parallel for better performance. - -:::tip - -You can also make the tasks given by the command line run in parallel by using the `--parallel` flag (alias `-p`). Example: `task --parallel js css`. - -::: - -If you want to pass information to dependencies, you can do that the same manner as you would to [call another task](#calling-another-task): - -```yaml -version: '3' - -tasks: - default: - deps: - - task: echo_sth - vars: { TEXT: 'before 1' } - - task: echo_sth - vars: { TEXT: 'before 2' } - silent: true - cmds: - - echo "after" - - echo_sth: - cmds: - - echo {{.TEXT}} -``` - -## Platform specific tasks and commands - -If you want to restrict the running of tasks to explicit platforms, this can be achieved using the `platforms:` key. Tasks can be restricted to a specific OS, architecture or a combination of both. On a mismatch, the task or command will be skipped, and no error will be thrown. - -The values allowed as OS or Arch are valid `GOOS` and `GOARCH` values, as defined by the Go language [here](https://github.com/golang/go/blob/master/src/go/build/syslist.go). - -The `build-windows` task below will run only on Windows, and on any architecture: - -```yaml -version: '3' - -tasks: - build-windows: - platforms: [windows] - cmds: - - echo 'Running command on Windows' -``` - -This can be restricted to a specific architecture as follows: - -```yaml -version: '3' - -tasks: - build-windows-amd64: - platforms: [windows/amd64] - cmds: - - echo 'Running command on Windows (amd64)' -``` - -It is also possible to restrict the task to specific architectures: - -```yaml -version: '3' - -tasks: - build-amd64: - platforms: [amd64] - cmds: - - echo 'Running command on amd64' -``` - -Multiple platforms can be specified as follows: - -```yaml -version: '3' - -tasks: - build: - platforms: [windows/amd64, darwin] - cmds: - - echo 'Running command on Windows (amd64) and macOS' -``` - -Individual commands can also be restricted to specific platforms: - -```yaml -version: '3' - -tasks: - build: - cmds: - - cmd: echo 'Running command on Windows (amd64) and macOS' - platforms: [windows/amd64, darwin] - - cmd: echo 'Running on all platforms' -``` - -## Calling another task - -When a task has many dependencies, they are executed concurrently. This will often result in a faster build pipeline. However, in some situations, you may need to call other tasks serially. In this case, use the following syntax: - -```yaml -version: '3' - -tasks: - main-task: - cmds: - - task: task-to-be-called - - task: another-task - - echo "Both done" - - task-to-be-called: - cmds: - - echo "Task to be called" - - another-task: - cmds: - - echo "Another task" -``` - -Using the `vars` and `silent` attributes you can choose to pass variables and toggle [silent mode](#silent-mode) on a call-by-call basis: - -```yaml -version: '3' - -tasks: - greet: - vars: - RECIPIENT: '{{default "World" .RECIPIENT}}' - cmds: - - echo "Hello, {{.RECIPIENT}}!" - - greet-pessimistically: - cmds: - - task: greet - vars: { RECIPIENT: 'Cruel World' } - silent: true -``` - -The above syntax is also supported in `deps`. - -:::tip - -NOTE: If you want to call a task declared in the root Taskfile from within an [included Taskfile](#including-other-taskfiles), add a leading `:` like this: `task: :task-name`. - -::: - -## Prevent unnecessary work - -### By fingerprinting locally generated files and their sources - -If a task generates something, you can inform Task the source and generated files, so Task will prevent running them if not necessary. - -```yaml -version: '3' - -tasks: - build: - deps: [js, css] - cmds: - - go build -v -i main.go - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - sources: - - src/js/**/*.js - generates: - - public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css - sources: - - src/css/**/*.css - generates: - - public/bundle.css -``` - -`sources` and `generates` can be files or glob patterns. When given, Task will compare the checksum of the source files to determine if it's necessary to run the task. If not, it will just print a message like `Task "js" is up to date`. - -`exclude:` can also be used to exclude files from fingerprinting. Sources are evaluated in order, so `exclude:` must come after the positive glob it is negating. - -```yaml -version: '3' - -tasks: - css: - sources: - - mysources/**/*.css - - exclude: mysources/ignoreme.css - generates: - - public/bundle.css -``` - -If you prefer these check to be made by the modification timestamp of the files, instead of its checksum (content), just set the `method` property to `timestamp`. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build . - sources: - - ./*.go - generates: - - app{{exeExt}} - method: timestamp -``` - -In situations where you need more flexibility the `status` keyword can be used. You can even combine the two. See the documentation for [status](#using-programmatic-checks-to-indicate-a-task-is-up-to-date) for an example. - -:::info - -By default, task stores checksums on a local `.task` directory in the project's directory. Most of the time, you'll want to have this directory on `.gitignore` (or equivalent) so it isn't committed. (If you have a task for code generation that is committed it may make sense to commit the checksum of that task as well, though). - -If you want these files to be stored in another directory, you can set a `TASK_TEMP_DIR` environment variable in your machine. It can contain a relative path like `tmp/task` that will be interpreted as relative to the project directory, or an absolute or home path like `/tmp/.task` or `~/.task` (subdirectories will be created for each project). - -```bash -export TASK_TEMP_DIR='~/.task' -``` - -::: - -:::info - -Each task has only one checksum stored for its `sources`. If you want to distinguish a task by any of its input variables, you can add those variables as part of the task's label, and it will be considered a different task. - -This is useful if you want to run a task once for each distinct set of inputs until the sources actually change. For example, if the sources depend on the value of a variable, or you if you want the task to rerun if some arguments change even if the source has not. - -::: - -:::tip - -The method `none` skips any validation and always run the task. - -::: - -:::info - -For the `checksum` (default) or `timestamp` method to work, it is only necessary to inform the source files. When the `timestamp` method is used, the last time of the running the task is considered as a generate. - -::: - -### Using programmatic checks to indicate a task is up to date - -Alternatively, you can inform a sequence of tests as `status`. If no error is returned (exit status 0), the task is considered up-to-date: - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - status: - - test -d directory - - test -f directory/file1.txt - - test -f directory/file2.txt -``` - -Normally, you would use `sources` in combination with `generates` - but for tasks that generate remote artifacts (Docker images, deploys, CD releases) the checksum source and timestamps require either access to the artifact or for an out-of-band refresh of the `.checksum` fingerprint file. - -Two special variables `{{.CHECKSUM}}` and `{{.TIMESTAMP}}` are available for interpolation within `status` commands, depending on the method assigned to fingerprint the sources. Only `source` globs are fingerprinted. - -Note that the `{{.TIMESTAMP}}` variable is a "live" Go `time.Time` struct, and can be formatted using any of the methods that `time.Time` responds to. - -See [the Go Time documentation](https://golang.org/pkg/time/) for more information. - -You can use `--force` or `-f` if you want to force a task to run even when up-to-date. - -Also, `task --status [tasks]...` will exit with a non-zero exit code if any of the tasks are not up-to-date. - -`status` can be combined with the [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) to have a task run if either the the source/generated artifacts changes, or the programmatic check fails: - -```yaml -version: '3' - -tasks: - build:prod: - desc: Build for production usage. - cmds: - - composer install - # Run this task if source files changes. - sources: - - composer.json - - composer.lock - generates: - - ./vendor/composer/installed.json - - ./vendor/autoload.php - # But also run the task if the last build was not a production build. - status: - - grep -q '"dev": false' ./vendor/composer/installed.json -``` - -### Using programmatic checks to cancel the execution of a task and its dependencies - -In addition to `status` checks, `preconditions` checks are the logical inverse of `status` checks. That is, if you need a certain set of conditions to be _true_ you can use the `preconditions` stanza. `preconditions` are similar to `status` lines, except they support `sh` expansion, and they SHOULD all return 0. - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - preconditions: - - test -f .env - - sh: '[ 1 = 0 ]' - msg: "One doesn't equal Zero, Halting" -``` - -Preconditions can set specific failure messages that can tell a user what steps to take using the `msg` field. - -If a task has a dependency on a sub-task with a precondition, and that precondition is not met - the calling task will fail. Note that a task executed with a failing precondition will not run unless `--force` is given. - -Unlike `status`, which will skip a task if it is up to date and continue executing tasks that depend on it, a `precondition` will fail a task, along with any other tasks that depend on it. - -```yaml -version: '3' - -tasks: - task-will-fail: - preconditions: - - sh: 'exit 1' - - task-will-also-fail: - deps: - - task-will-fail - - task-will-still-fail: - cmds: - - task: task-will-fail - - echo "I will not run" -``` - -### Limiting when tasks run - -If a task executed by multiple `cmds` or multiple `deps` you can control when it is executed using `run`. `run` can also be set at the root of the Taskfile to change the behavior of all the tasks unless explicitly overridden. - -Supported values for `run`: - -- `always` (default) always attempt to invoke the task regardless of the number of previous executions -- `once` only invoke this task once regardless of the number of references -- `when_changed` only invokes the task once for each unique set of variables passed into the task - -```yaml -version: '3' - -tasks: - default: - cmds: - - task: generate-file - vars: { CONTENT: '1' } - - task: generate-file - vars: { CONTENT: '2' } - - task: generate-file - vars: { CONTENT: '2' } - - generate-file: - run: when_changed - deps: - - install-deps - cmds: - - echo {{.CONTENT}} - - install-deps: - run: once - cmds: - - sleep 5 # long operation like installing packages -``` - -### Ensuring required variables are set - -If you want to check that certain variables are set before running a task then you can use `requires`. This is useful when might not be clear to users which variables are needed, or if you want clear message about what is required. Also some tasks could have dangerous side effects if run with un-set variables. - -Using `requires` you specify an array of strings in the `vars` sub-section under `requires`, these strings are variable names which are checked prior to running the task. If any variables are un-set the the task will error and not run. - -Environmental variables are also checked. - -Syntax: - -```yaml -requires: - vars: [] # Array of strings -``` - -:::note - -Variables set to empty zero length strings, will pass the `requires` check. - -::: - -Example of using `requires`: - -```yaml -version: '3' - -tasks: - docker-build: - cmds: - - 'docker build . -t {{.IMAGE_NAME}}:{{.IMAGE_TAG}}' - - # Make sure these variables are set before running - requires: - vars: [IMAGE_NAME, IMAGE_TAG] -``` - -## Variables - -When doing interpolation of variables, Task will look for the below. They are listed below in order of importance (i.e. most important first): - -- Variables declared in the task definition -- Variables given while calling a task from another (See [Calling another task](#calling-another-task) above) -- Variables of the [included Taskfile](#including-other-taskfiles) (when the task is included) -- Variables of the [inclusion of the Taskfile](#vars-of-included-taskfiles) (when the task is included) -- Global variables (those declared in the `vars:` option in the Taskfile) -- Environment variables - -Example of sending parameters with environment variables: - -```bash -$ TASK_VARIABLE=a-value task do-something -``` - -:::tip - -A special variable `.TASK` is always available containing the task name. - -::: - -Since some shells do not support the above syntax to set environment variables (Windows) tasks also accept a similar style when not at the beginning of the command. - -```bash -$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!" -``` - -Example of locally declared vars: - -```yaml -version: '3' - -tasks: - print-var: - cmds: - - echo "{{.VAR}}" - vars: - VAR: Hello! -``` - -Example of global vars in a `Taskfile.yml`: - -```yaml -version: '3' - -vars: - GREETING: Hello from Taskfile! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -### Dynamic variables - -The below syntax (`sh:` prop in a variable) is considered a dynamic variable. The value will be treated as a command and the output assigned. If there are one or more trailing newlines, the last newline will be trimmed. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go - vars: - GIT_COMMIT: - sh: git log -n 1 --format=%h -``` - -This works for all types of variables. - -## Looping over values - -As of v3.28.0, Task allows you to loop over certain values and execute a command for each. There are a number of ways to do this depending on the type of value you want to loop over. - -### Looping over a static list - -The simplest kind of loop is an explicit one. This is useful when you want to loop over a set of values that are known ahead of time. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: ['foo.txt', 'bar.txt'] - cmd: cat {{ .ITEM }} -``` - -### Looping over your task's sources - -You are also able to loop over the sources of your task: - -```yaml -version: '3' - -tasks: - default: - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{ .ITEM }} -``` - -This will also work if you use globbing syntax in your sources. For example, if you specify a source for `*.txt`, the loop will iterate over all files that match that glob. - -Source paths will always be returned as paths relative to the task directory. If you need to convert this to an absolute path, you can use the built-in `joinPath` function. There are some [special variables](/api/#special-variables) that you may find useful for this. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_DIR: /path/to/dir - dir: '{{.MY_DIR}}' - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{joinPath .MY_DIR .ITEM}} -``` - -### Looping over variables - -To loop over the contents of a variable, you simply need to specify the variable you want to loop over. By default, variables will be split on any whitespace characters. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -If you need to split on a different character, you can do this by specifying the `split` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt,bar.txt - cmds: - - for: { var: MY_VAR, split: ',' } - cmd: cat {{.ITEM}} -``` - -All of this also works with dynamic variables! - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: - sh: find -type f -name '*.txt' - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -### Renaming variables - -If you want to rename the iterator variable to make it clearer what the value contains, you can do so by specifying the `as` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR, as: FILE } - cmd: cat {{.FILE}} -``` - -### Looping over tasks - -Because the `for` property is defined at the `cmds` level, you can also use it alongside the `task` keyword to run tasks multiple times with different variables. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: my-task - vars: - FILE: '{{.ITEM}}' - - my-task: - cmds: - - echo '{{.FILE}}' -``` - -Or if you want to run different tasks depending on the value of the loop: - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: task-{{.ITEM}} - - task-foo: - cmds: - - echo 'foo' - - task-bar: - cmds: - - echo 'bar' -``` - -## Forwarding CLI arguments to commands - -If `--` is given in the CLI, all following parameters are added to a special `.CLI_ARGS` variable. This is useful to forward arguments to another command. - -The below example will run `yarn install`. - -```bash -$ task yarn -- install -``` - -```yaml -version: '3' - -tasks: - yarn: - cmds: - - yarn {{.CLI_ARGS}} -``` - -## Doing task cleanup with `defer` - -With the `defer` keyword, it's possible to schedule cleanup to be run once the task finishes. The difference with just putting it as the last command is that this command will run even when the task fails. - -In the example below, `rm -rf tmpdir/` will run even if the third command fails: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: rm -rf tmpdir/ - - echo 'Do work on tmpdir/' -``` - -If you want to move the cleanup command into another task, that is possible as well: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: { task: cleanup } - - echo 'Do work on tmpdir/' - - cleanup: rm -rf tmpdir/ -``` - -:::info - -Due to the nature of how the [Go's own `defer` work](https://go.dev/tour/flowcontrol/13), the deferred commands are executed in the reverse order if you schedule multiple of them. - -::: - -## Go's template engine - -Task parse commands as [Go's template engine][gotemplate] before executing them. Variables are accessible through dot syntax (`.VARNAME`). - -All functions by the Go's [slim-sprig lib](https://go-task.github.io/slim-sprig/) are available. The following example gets the current date in a given format: - -```yaml -version: '3' - -tasks: - print-date: - cmds: - - echo {{now | date "2006-01-02"}} -``` - -Task also adds the following functions: - -- `OS`: Returns the operating system. Possible values are `windows`, `linux`, `darwin` (macOS) and `freebsd`. -- `ARCH`: return the architecture Task was compiled to: `386`, `amd64`, `arm` or `s390x`. -- `splitLines`: Splits Unix (`\n`) and Windows (`\r\n`) styled newlines. -- `catLines`: Replaces Unix (`\n`) and Windows (`\r\n`) styled newlines with a space. -- `toSlash`: Does nothing on Unix, but on Windows converts a string from `\` path format to `/`. -- `fromSlash`: Opposite of `toSlash`. Does nothing on Unix, but on Windows converts a string from `/` path format to `\`. -- `exeExt`: Returns the right executable extension for the current OS (`".exe"` for Windows, `""` for others). -- `shellQuote`: Quotes a string to make it safe for use in shell scripts. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote) for this. The Bash dialect is assumed. -- `splitArgs`: Splits a string as if it were a command's arguments. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/shell#Fields) - -Example: - -```yaml -version: '3' - -tasks: - print-os: - cmds: - - echo '{{OS}} {{ARCH}}' - - echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}' - # This will be path/to/file on Unix but path\to\file on Windows - - echo '{{fromSlash "path/to/file"}}' - enumerated-file: - vars: - CONTENT: | - foo - bar - cmds: - - | - cat << EOF > output.txt - {{range $i, $line := .CONTENT | splitLines -}} - {{printf "%3d" $i}}: {{$line}} - {{end}}EOF -``` - -## Help - -Running `task --list` (or `task -l`) lists all tasks with a description. The following Taskfile: - -```yaml -version: '3' - -tasks: - build: - desc: Build the go binary. - cmds: - - go build -v -i main.go - - test: - desc: Run all the go tests. - cmds: - - go test -race ./... - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -would print the following output: - -```bash -* build: Build the go binary. -* test: Run all the go tests. -``` - -If you want to see all tasks, there's a `--list-all` (alias `-a`) flag as well. - -## Display summary of task - -Running `task --summary task-name` will show a summary of a task. The following Taskfile: - -```yaml -version: '3' - -tasks: - release: - deps: [build] - summary: | - Release your project to github - - It will build your project before starting the release. - Please make sure that you have set GITHUB_TOKEN before starting. - cmds: - - your-release-tool - - build: - cmds: - - your-build-tool -``` - -with running `task --summary release` would print the following output: - -``` -task: release - -Release your project to github - -It will build your project before starting the release. -Please make sure that you have set GITHUB_TOKEN before starting. - -dependencies: - - build - -commands: - - your-release-tool -``` - -If a summary is missing, the description will be printed. If the task does not have a summary or a description, a warning is printed. - -Please note: _showing the summary will not execute the command_. - -## Task aliases - -Aliases are alternative names for tasks. They can be used to make it easier and quicker to run tasks with long or hard-to-type names. You can use them on the command line, when [calling sub-tasks](#calling-another-task) in your Taskfile and when [including tasks](#including-other-taskfiles) with aliases from another Taskfile. They can also be used together with [namespace aliases](#namespace-aliases). - -```yaml -version: '3' - -tasks: - generate: - aliases: [gen] - cmds: - - task: gen-mocks - - generate-mocks: - aliases: [gen-mocks] - cmds: - - echo "generating..." -``` - -## Overriding task name - -Sometimes you may want to override the task name printed on the summary, up-to-date messages to STDOUT, etc. In this case, you can just set `label:`, which can also be interpolated with variables: - -```yaml -version: '3' - -tasks: - default: - - task: print - vars: - MESSAGE: hello - - task: print - vars: - MESSAGE: world - - print: - label: 'print-{{.MESSAGE}}' - cmds: - - echo "{{.MESSAGE}}" -``` - -## Warning Prompts - -Warning Prompts are used to prompt a user for confirmation before a task is executed. - -Below is an example using `prompt` with a dangerous command, that is called between two safe commands: - -```yaml -version: '3' - -tasks: - example: - cmds: - - task: not-dangerous - - task: dangerous - - task: another-not-dangerous - - not-dangerous: - cmds: - - echo 'not dangerous command' - - another-not-dangerous: - cmds: - - echo 'another not dangerous command' - - dangerous: - prompt: This is a dangerous command... Do you want to continue? - cmds: - - echo 'dangerous command' -``` - -```bash -❯ task dangerous -task: "This is a dangerous command... Do you want to continue?" [y/N] -``` - -Warning prompts are called before executing a task. If a prompt is denied Task will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue as normal. - -```bash -❯ task example -not dangerous command -task: "This is a dangerous command. Do you want to continue?" [y/N] -y -dangerous command -another not dangerous command -``` - -To skip warning prompts automatically, you can use the `--yes` (alias `-y`) option when calling the task. By including this option, all warnings, will be automatically confirmed, and no prompts will be shown. - -:::caution - -Tasks with prompts always fail by default on non-terminal environments, like a CI, where an `stdin` won't be available for the user to answer. In those cases, use `--yes` (`-y`) to force all tasks with a prompt to run. - -::: - -## Silent mode - -Silent mode disables the echoing of commands before Task runs it. For the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" -``` - -Normally this will be printed: - -```sh -echo "Print something" -Print something -``` - -With silent mode on, the below will be printed instead: - -```sh -Print something -``` - -There are four ways to enable silent mode: - -- At command level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: echo "Print something" - silent: true -``` - -- At task level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" - silent: true -``` - -- Globally at Taskfile level: - -```yaml -version: '3' - -silent: true - -tasks: - echo: - cmds: - - echo "Print something" -``` - -- Or globally with `--silent` or `-s` flag - -If you want to suppress STDOUT instead, just redirect a command to `/dev/null`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "This will print nothing" > /dev/null -``` - -## Dry run mode - -Dry run mode (`--dry`) compiles and steps through each task, printing the commands that would be run without executing them. This is useful for debugging your Taskfiles. - -## Ignore errors - -You have the option to ignore errors during command execution. Given the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - exit 1 - - echo "Hello World" -``` - -Task will abort the execution after running `exit 1` because the status code `1` stands for `EXIT_FAILURE`. However, it is possible to continue with execution using `ignore_error`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "Hello World" -``` - -`ignore_error` can also be set for a task, which means errors will be suppressed for all commands. Nevertheless, keep in mind that this option will not propagate to other tasks called either by `deps` or `cmds`! - -## Output syntax - -By default, Task just redirects the STDOUT and STDERR of the running commands to the shell in real-time. This is good for having live feedback for logging printed by commands, but the output can become messy if you have multiple commands running simultaneously and printing lots of stuff. - -To make this more customizable, there are currently three different output options you can choose: - -- `interleaved` (default) -- `group` -- `prefixed` - -To choose another one, just set it to root in the Taskfile: - -```yaml -version: '3' - -output: 'group' - -tasks: - # ... -``` - -The `group` output will print the entire output of a command once after it finishes, so you will not have live feedback for commands that take a long time to run. - -When using the `group` output, you can optionally provide a templated message to print at the start and end of the group. This can be useful for instructing CI systems to group all of the output for a given task, such as with [GitHub Actions' `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) or [Azure Pipelines](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?expand=1&view=azure-devops&tabs=bash#formatting-commands). - -```yaml -version: '3' - -output: - group: - begin: '::group::{{.TASK}}' - end: '::endgroup::' - -tasks: - default: - cmds: - - echo 'Hello, World!' - silent: true -``` - -```bash -$ task default -::group::default -Hello, World! -::endgroup:: -``` - -When using the `group` output, you may swallow the output of the executed command on standard output and standard error if it does not fail (zero exit code). - -```yaml -version: '3' - -silent: true - -output: - group: - error_only: true - -tasks: - passes: echo 'output-of-passes' - errors: echo 'output-of-errors' && exit 1 -``` - -```bash -$ task passes -$ task errors -output-of-errors -task: Failed to run task "errors": exit status 1 -``` - -The `prefix` output will prefix every line printed by a command with `[task-name]` as the prefix, but you can customize the prefix for a command with the `prefix:` attribute: - -```yaml -version: '3' - -output: prefixed - -tasks: - default: - deps: - - task: print - vars: { TEXT: foo } - - task: print - vars: { TEXT: bar } - - task: print - vars: { TEXT: baz } - - print: - cmds: - - echo "{{.TEXT}}" - prefix: 'print-{{.TEXT}}' - silent: true -``` - -```bash -$ task default -[print-foo] foo -[print-bar] bar -[print-baz] baz -``` - -:::tip - -The `output` option can also be specified by the `--output` or `-o` flags. - -::: - -## Interactive CLI application - -When running interactive CLI applications inside Task they can sometimes behave weirdly, especially when the [output mode](#output-syntax) is set to something other than `interleaved` (the default), or when interactive apps are run in parallel with other tasks. - -The `interactive: true` tells Task this is an interactive application and Task will try to optimize for it: - -```yaml -version: '3' - -tasks: - default: - cmds: - - vim my-file.txt - interactive: true -``` - -If you still have problems running an interactive app through Task, please open an issue about it. - -## Short task syntax - -Starting on Task v3, you can now write tasks with a shorter syntax if they have the default settings (e.g. no custom `env:`, `vars:`, `desc:`, `silent:` , etc): - -```yaml -version: '3' - -tasks: - build: go build -v -o ./app{{exeExt}} . - - run: - - task: build - - ./app{{exeExt}} -h localhost -p 8080 -``` - -## `set` and `shopt` - -It's possible to specify options to the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins. This can be added at global, task or command level. - -```yaml -version: '3' - -set: [pipefail] -shopt: [globstar] - -tasks: - # `globstar` required for double star globs to work - default: echo **/*.go -``` - -:::info - -Keep in mind that not all options are available in the [shell interpreter library](https://github.com/mvdan/sh) that Task uses. - -::: - -## Watch tasks - -With the flags `--watch` or `-w` task will watch for file changes and run the task again. This requires the `sources` attribute to be given, so task knows which files to watch. - -The default watch interval is 5 seconds, but it's possible to change it by either setting `interval: '500ms'` in the root of the Taskfile passing it as an argument like `--interval=500ms`. - -Also, it's possible to set `watch: true` in a given task and it'll automatically run in watch mode: - -```yaml -version: '3' - -interval: 500ms - -tasks: - build: - desc: Builds the Go application - watch: true - sources: - - '**/*.go' - cmds: - - go build # ... -``` - -:::info - -Note that when setting `watch: true` to a task, it'll only run in watch mode when running from the CLI via `task my-watch-task`, but won't run in watch mode if called by another task, either directly or as a dependency. - -::: - - - - -[gotemplate]: https://golang.org/pkg/text/template/ diff --git a/docs/i18n/fr-FR/docusaurus-theme-classic/footer.json b/docs/i18n/fr-FR/docusaurus-theme-classic/footer.json deleted file mode 100644 index 707c707a..00000000 --- a/docs/i18n/fr-FR/docusaurus-theme-classic/footer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "link.title.Pages": { - "message": "Pages", - "description": "The title of the footer links column with title=Pages in the footer" - }, - "link.title.Community": { - "message": "Communauté", - "description": "The title of the footer links column with title=Community in the footer" - }, - "link.title.Translations": { - "message": "Traductions", - "description": "The title of the footer links column with title=Translations in the footer" - }, - "link.item.label.Installation": { - "message": "Installation", - "description": "The label of footer link with label=Installation linking to /installation/" - }, - "link.item.label.Usage": { - "message": "Utilisation", - "description": "The label of footer link with label=Usage linking to /usage/" - }, - "link.item.label.Donate": { - "message": "Faire un don", - "description": "The label of footer link with label=Donate linking to /donate/" - }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/go-task/task" - }, - "link.item.label.Twitter": { - "message": "Twitter", - "description": "The label of footer link with label=Twitter linking to https://twitter.com/taskfiledev" - }, - "link.item.label.Mastodon": { - "message": "Mastodon", - "description": "The label of footer link with label=Mastodon linking to https://fosstodon.org/@task" - }, - "link.item.label.Discord": { - "message": "Discord", - "description": "The label of footer link with label=Discord linking to https://discord.gg/6TY36E39UK" - }, - "link.item.label.OpenCollective": { - "message": "OpenCollective", - "description": "The label of footer link with label=OpenCollective linking to https://opencollective.com/task" - } -} diff --git a/docs/i18n/fr-FR/docusaurus-theme-classic/navbar.json b/docs/i18n/fr-FR/docusaurus-theme-classic/navbar.json deleted file mode 100644 index b72cefb5..00000000 --- a/docs/i18n/fr-FR/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "title": { - "message": "Task", - "description": "The title in the navbar" - }, - "item.label.Installation": { - "message": "Installation", - "description": "Navbar item with label Installation" - }, - "item.label.Usage": { - "message": "Utilisation", - "description": "Navbar item with label Usage" - }, - "item.label.API": { - "message": "API", - "description": "Navbar item with label API" - }, - "item.label.Donate": { - "message": "Faire un don", - "description": "Navbar item with label Donate" - }, - "item.label.GitHub": { - "message": "GitHub", - "description": "Navbar item with label GitHub" - }, - "item.label.Twitter": { - "message": "Twitter", - "description": "Navbar item with label Twitter" - }, - "item.label.Mastodon": { - "message": "Mastodon", - "description": "Navbar item with label Mastodon" - }, - "item.label.Discord": { - "message": "Discord", - "description": "Navbar item with label Discord" - } -} diff --git a/docs/i18n/ja-JP/code.json b/docs/i18n/ja-JP/code.json deleted file mode 100644 index 2c036f2e..00000000 --- a/docs/i18n/ja-JP/code.json +++ /dev/null @@ -1,396 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "ページがクラッシュしました。", - "description": "The title of the fallback page when the page crashed" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "もう一度お試しください", - "description": "The label of the button to try again when the page crashed" - }, - "theme.NotFound.title": { - "message": "ページが見つかりませんでした", - "description": "The title of the 404 page" - }, - "theme.NotFound.p1": { - "message": "お探しのページが見つかりませんでした。", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "アクセスを試みたのURLをリンクしたサイトの管理者に連絡して、そのリンクが壊れていることを知らせてください。", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.admonition.note": { - "message": "メモ", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "ヒント", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.danger": { - "message": "危険", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "お知らせ", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.caution": { - "message": "注意", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "ページ上部へ戻る", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "アーカイブ", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "アーカイブ", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Blog list page navigation", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Newer Entries", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Older Entries", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Blog post page navigation", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Newer Post", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Older Post", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "One post|{count} posts", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} tagged with \"{tagName}\"", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "View All Tags", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Switch between dark and light mode (currently {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "dark mode", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "light mode", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.home": { - "message": "Home page", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Breadcrumbs", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} items", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Docs pages navigation", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Previous", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Next", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "One doc tagged|{count} docs tagged", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} with \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Version: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "This is unreleased documentation for {siteTitle} {versionLabel} version.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "latest version", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Edit this page", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Direct link to heading", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " on {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " by {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Last updated{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Versions", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Tags:", - "description": "The label alongside a tag list" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Close", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Blog recent posts navigation", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Copied", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Copy code to clipboard", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "コピー", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Toggle word wrap", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "Toggle the collapsible sidebar category '{label}'", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Languages", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "On this page", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "Read More", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "Read more about {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "One min read|{readingTime} min read", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Close navigation bar", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← Back to main menu", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Toggle navigation bar", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.seeAll": { - "message": "See all {count} results" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "One document found|{count} documents found", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Search results for \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Search the documentation", - "description": "The search page title for empty query" - }, - "theme.SearchPage.inputPlaceholder": { - "message": "Type your search here", - "description": "The placeholder for search page input" - }, - "theme.SearchPage.inputLabel": { - "message": "Search", - "description": "The ARIA label for search page input" - }, - "theme.SearchPage.algoliaLabel": { - "message": "Search by Algolia", - "description": "The ARIA label for Algolia mention" - }, - "theme.SearchPage.noResultsText": { - "message": "No results were found", - "description": "The paragraph for empty search result" - }, - "theme.SearchPage.fetchingNewResults": { - "message": "Fetching new results...", - "description": "The paragraph for fetching new search results" - }, - "theme.SearchBar.label": { - "message": "Search", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchModal.searchBox.resetButtonTitle": { - "message": "Clear the query", - "description": "The label and ARIA label for search box reset button" - }, - "theme.SearchModal.searchBox.cancelButtonText": { - "message": "Cancel", - "description": "The label and ARIA label for search box cancel button" - }, - "theme.SearchModal.startScreen.recentSearchesTitle": { - "message": "Recent", - "description": "The title for recent searches" - }, - "theme.SearchModal.startScreen.noRecentSearchesText": { - "message": "No recent searches", - "description": "The text when no recent searches" - }, - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { - "message": "Save this search", - "description": "The label for save recent search button" - }, - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { - "message": "Remove this search from history", - "description": "The label for remove recent search button" - }, - "theme.SearchModal.startScreen.favoriteSearchesTitle": { - "message": "Favorite", - "description": "The title for favorite searches" - }, - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { - "message": "Remove this search from favorites", - "description": "The label for remove favorite search button" - }, - "theme.SearchModal.errorScreen.titleText": { - "message": "Unable to fetch results", - "description": "The title for error screen of search modal" - }, - "theme.SearchModal.errorScreen.helpText": { - "message": "You might want to check your network connection.", - "description": "The help text for error screen of search modal" - }, - "theme.SearchModal.footer.selectText": { - "message": "to select", - "description": "The explanatory text of the action for the enter key" - }, - "theme.SearchModal.footer.selectKeyAriaLabel": { - "message": "Enter key", - "description": "The ARIA label for the Enter key button that makes the selection" - }, - "theme.SearchModal.footer.navigateText": { - "message": "to navigate", - "description": "The explanatory text of the action for the Arrow up and Arrow down key" - }, - "theme.SearchModal.footer.navigateUpKeyAriaLabel": { - "message": "Arrow up", - "description": "The ARIA label for the Arrow up key button that makes the navigation" - }, - "theme.SearchModal.footer.navigateDownKeyAriaLabel": { - "message": "Arrow down", - "description": "The ARIA label for the Arrow down key button that makes the navigation" - }, - "theme.SearchModal.footer.closeText": { - "message": "to close", - "description": "The explanatory text of the action for Escape key" - }, - "theme.SearchModal.footer.closeKeyAriaLabel": { - "message": "Escape key", - "description": "The ARIA label for the Escape key button that close the modal" - }, - "theme.SearchModal.footer.searchByText": { - "message": "Search by", - "description": "The text explain that the search is making by Algolia" - }, - "theme.SearchModal.noResultsScreen.noResultsText": { - "message": "No results for", - "description": "The text explains that there are no results for the following search" - }, - "theme.SearchModal.noResultsScreen.suggestedQueryText": { - "message": "Try searching for", - "description": "The text for the suggested query when no results are found for the following search" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsText": { - "message": "Believe this query should return results?", - "description": "The text for the question where the user thinks there are missing results" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { - "message": "Let us know.", - "description": "The text for the link to report missing results" - }, - "theme.SearchModal.placeholder": { - "message": "Search docs", - "description": "The placeholder of the input of the DocSearch pop-up modal" - }, - "theme.common.skipToMainContent": { - "message": "Skip to main content", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Tags", - "description": "The title of the tag list page" - } -} diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md b/docs/i18n/ja-JP/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md deleted file mode 100644 index 42d99117..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Introducing Experiments -description: A look at where task is, where it's going and how we're going to get there. -slug: task-in-2023 -authors: - - pd93 -tags: - - experiments - - breaking-changes - - roadmap - - v4 -image: https://i.imgur.com/mErPwqL.png -hide_table_of_contents: false ---- - -Lately, Task has been growing extremely quickly and I've found myself thinking a lot about the future of the project and how we continue to evolve and grow. I'm not much of a writer, but I think one of the things we could do better is to communicate these kinds of thoughts to the community. So, with that in mind, this is the first (hopefully of many) blog posts talking about Task and what we're up to. - - - -## :calendar: So, what have we been up to? - -Over the past 12 months or so, [@andreynering][] (Author and maintainer of the project) and I ([@pd93][]) have been working in our spare time to maintain and improve v3 of Task and we've made some amazing progress. Here are just some of the things we've released in that time: - -- An official [extension for VS Code][vscode-task]. -- Internal Tasks ([#818](https://github.com/go-task/task/pull/818)). -- Task aliases ([#879](https://github.com/go-task/task/pull/879)). -- Looping over tasks ([#1220](https://github.com/go-task/task/pull/1200)). -- A series of refactors to the core codebase to make it more maintainable and extensible. -- Loads of bug fixes and improvements. -- An integration with [Crowdin][crowdin]. Work is in progress on making our docs available in **7 new languages** (Special thanks to all our translators for the huge help with this!). -- And much, much more! :sparkles: - -We're also working on adding some really exciting and highly requested features to Task such as having the ability to run remote Taskfiles ([#1317](https://github.com/go-task/task/issues/1317)). - -None of this would have been possible without the [150 or so (and growing) contributors][contributors] to the project, numerous sponsors and a passionate community of users. Together we have more than doubled the number of GitHub stars to over 8400 :star: since the beginning of 2022 and this continues to accelerate. We can't thank you all enough for your help and support! :rocket: - -[![Star History Chart](https://api.star-history.com/svg?repos=go-task/task&type=Date)](https://star-history.com/#go-task/task&Date) - -## What's next? :thinking: - -It's extremely motivating to see so many people using and loving Task. However, in this time we've also seen an increase in the number of issues and feature requests. In particular, issues that require some kind of breaking change to Task. This isn't a bad thing, but as we grow we need to be more responsible about how we address these changes in a way that ensures stability and compatibility for existing users and their Taskfiles. - -At this point you're probably thinking something like: - -> "But you use [semantic versioning][semver] - Just release a new major version with your breaking changes." - -And you'd be right... sort of. In theory, this sounds great, but the reality is that we don't have the time to commit to a major overhaul of Task in one big bang release. This would require a colossal amount of time and coordination and with full time jobs and personal lives to tend to, this is a difficult commitment to make. Smaller, more frequent major releases are also a significant inconvenience for users as they have to constantly keep up-to-date with our breaking changes. Fortunately, there is a better way. - -## What's going to change? :monocle: - -Going forwards, breaking changes will be allowed into _minor_ versions of Task as "experimental features". To access these features users will need opt-in by enabling feature flags. This will allow us to release new features slowly and gather feedback from the community before making them the default behavior in a future major release. - -To prepare users for the next major release, we will maintain a list of [deprecated features][deprecations] and [experiments][experiments] on our docs website and publish information on how to migrate to the new behavior. - -You can read the [full breaking change proposal][breaking-change-proposal] and view all the [current experiments and their status][experiments-project] on GitHub including the [Gentle Force][gentle-force-experiment] and [Remote Taskfiles][remote-taskfiles-experiment] experiments. - -## What will happen to v2/v3 features? - -v2 has been [officially deprecated][deprecate-version-2-schema]. If you're still using a Taskfile with `version: "2"` at the top we _strongly recommend_ that you upgrade as soon as possible. Removing v2 will allow us to tidy up the codebase and focus on new functionality instead. - -When v4 is released, we will continue to support v3 for a period of time (bug fixes etc). However, since we are moving from a backward-compatibility model to a forwards-compatibility model, **v4 itself will not be backwards compatible with v3**. - -## v4 When? :eyes: - -:man_shrugging: When it's ready. - -In all seriousness, we don't have a timeline for this yet. We'll be working on the most serious deficiencies of the v3 API first and regularly evaluating the state of the project. When we feel its in a good, stable place and we have a clear upgrade path for users and a number of stable experiments, we'll start to think about v4. - -## :wave: Final thoughts - -Task is growing fast and we're excited to see where it goes next. We hope that the steps we're taking to improve the project and our process will help us to continue to grow. As always, if you have any questions or feedback, we encourage you to comment on or open [issues][issues] and [discussions][discussions] on GitHub. Alternatively, you can join us on [Discord][discord]. - -I plan to write more of these blog posts in the future on a variety of Task-related topics, so make sure to check in occasionally and see what we're up to! - - - - -[vscode-task]: https://github.com/go-task/vscode-task -[crowdin]: https://crowdin.com -[contributors]: https://github.com/go-task/task/graphs/contributors -[semver]: https://semver.org -[breaking-change-proposal]: https://github.com/go-task/task/discussions/1191 -[@andreynering]: https://github.com/andreynering -[@pd93]: https://github.com/pd93 -[experiments]: https://taskfile.dev/experiments -[deprecations]: https://taskfile.dev/deprecations -[deprecate-version-2-schema]: https://github.com/go-task/task/issues/1197 -[issues]: https://github.com/go-task/task/issues -[discussions]: https://github.com/go-task/task/discussions -[discord]: https://discord.gg/6TY36E39UK -[experiments-project]: https://github.com/orgs/go-task/projects/1 -[gentle-force-experiment]: https://github.com/go-task/task/issues/1200 -[remote-taskfiles-experiment]: https://github.com/go-task/task/issues/1317 diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-blog/authors.yml b/docs/i18n/ja-JP/docusaurus-plugin-content-blog/authors.yml deleted file mode 100644 index faf905af..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-blog/authors.yml +++ /dev/null @@ -1,10 +0,0 @@ -andreynering: - name: Andrey Nering - title: Taskメンテナー - url: https://github.com/andreynering - image_url: https://github.com/andreynering.png -pd93: - name: Pete Davison - title: Maintainer of Task - url: https://github.com/pd93 - image_url: https://github.com/pd93.png diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current.json b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index dd4aab07..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version.label": { - "message": "次へ", - "description": "The label for version current" - } -} diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/api_reference.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/api_reference.md deleted file mode 100644 index cfd3ce9c..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/api_reference.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -slug: /api/ -sidebar_position: 4 -toc_min_heading_level: 2 -toc_max_heading_level: 5 ---- - -# APIリファレンス - -## CLI - -Taskコマンドラインツールは以下のような構文を持っています: - -```bash -task [--flags] [tasks...] [-- CLI_ARGS...] -``` - -:::tip - -`--`が渡されると、次に続く全てのパラメータは`CLI_ARGS`という特別な変数に格納されます - -::: - -| ショート | フラグ | 型 | デフォルト値 | 説明 | -| ---- | --------------------------- | -------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-c` | `--color` | `bool` | `true` | 色付き出力。 デフォルトで有効。 `false`または` NO_COLOR=1`を使用することで無効にできます。 | -| `-C` | `--concurrency` | `int` | `0` | 同時に実行するタスクを制限します。 0は無制限を意味します。 | -| `-d` | `--dir` | `string` | ワーキングディレクトリ | 実行するディレクトリを指定します。 | -| `-n` | `--dry` | `bool` | `false` | タスクを実行せずに、コンパイルして実行される順番を表示します。 | -| `-x` | `--exit-code` | `bool` | `false` | taskコマンドの終了コードを変更や加工を行わずにそのまま伝えます。 | -| `-f` | `--force` | `bool` | `false` | Forces execution even when the task is up-to-date. | -| `-g` | `--global` | `bool` | `false` | Runs global Taskfile, from `$HOME/Taskfile.{yml,yaml}`. | -| `-h` | `--help` | `bool` | `false` | Shows Task usage. | -| `-i` | `--init` | `bool` | `false` | Creates a new Taskfile.yml in the current folder. | -| `-I` | `--interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `-l` | `--list` | `bool` | `false` | Lists tasks with description of current Taskfile. | -| `-a` | `--list-all` | `bool` | `false` | Lists tasks with or without a description. | -| | `--sort` | `string` | `default` | Changes the order of the tasks when listed.
`default` - Alphanumeric with root tasks first
`alphanumeric` - Alphanumeric
`none` - No sorting (As they appear in the Taskfile) | -| | `--json` | `bool` | `false` | [JSON出力](#json-output)を参照してください。 | -| `-o` | `--output` | `string` | Default set in the Taskfile or `intervealed` | Sets output style: [`interleaved`/`group`/`prefixed`]. | -| | `--output-group-begin` | `string` | | Message template to print before a task's grouped output. | -| | `--output-group-end` | `string` | | Message template to print after a task's grouped output. | -| | `--output-group-error-only` | `bool` | `false` | Swallow command output on zero exit code. | -| `-p` | `--parallel` | `bool` | `false` | コマンドラインで指定したタスクを並列に実行します。 | -| `-s` | `--silent` | `bool` | `false` | エコーを無効にします。 | -| `-y` | `--yes` | `bool` | `false` | Assume "yes" as answer to all prompts. | -| | `--status` | `bool` | `false` | Exits with non-zero exit code if any of the given tasks is not up-to-date. | -| | `--summary` | `bool` | `false` | タスクのサマリーを表示します。 | -| `-t` | `--taskfile` | `string` | `Taskfile.yml`または`Taskfile.yaml` | | -| `-v` | `--verbose` | `bool` | `false` | 冗長モードを有効にします。 | -| | `--version` | `bool` | `false` | Taskのバージョンを表示。 | -| `-w` | `--watch` | `bool` | `false` | 指定したタスクの監視を有効にします。 | - -## 終了コード - -Task will sometimes exit with specific exit codes. These codes are split into three groups with the following ranges: - -- General errors (0-99) -- Taskfile errors (100-199) -- Task errors (200-299) - -A full list of the exit codes and their descriptions can be found below: - -| コード | 説明 | -| --- | ------------------------------------------------------------ | -| 0 | 成功 | -| 1 | 不明なエラー | -| 100 | Taskfileが見つかりません | -| 101 | A Taskfile already exists when trying to initialize one | -| 102 | The Taskfile is invalid or cannot be parsed | -| 103 | A remote Taskfile could not be downloaded | -| 104 | A remote Taskfile was not trusted by the user | -| 105 | A remote Taskfile was could not be fetched securely | -| 106 | No cache was found for a remote Taskfile in offline mode | -| 107 | No schema version was defined in the Taskfile | -| 200 | The specified task could not be found | -| 201 | An error occurred while executing a command inside of a task | -| 202 | The user tried to invoke a task that is internal | -| 203 | There a multiple tasks with the same name or alias | -| 204 | A task was called too many times | -| 205 | A task was cancelled by the user | -| 206 | A task was not executed due to missing required variables | - -これらのコードは[`errors/errors.go`](https://github.com/go-task/task/blob/main/errors/errors.go)にあります。 - -:::info - -When Task is run with the `-x`/`--exit-code` flag, the exit code of any failed commands will be passed through to the user instead. - -::: - -## JSON出力 - -When using the `--json` flag in combination with either the `--list` or `--list-all` flags, the output will be a JSON object with the following structure: - -```json -{ - "tasks": [ - { - "name": "", - "desc": "", - "summary": "", - "up_to_date": false, - "location": { - "line": 54, - "column": 3, - "taskfile": "/path/to/Taskfile.yml" - } - } - // ... - ], - "location": "/path/to/Taskfile.yml" -} -``` - -## 特殊な変数 - -There are some special variables that is available on the templating system: - -| 変数 | 説明 | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CLI_ARGS` | Contain all extra arguments passed after `--` when calling Task through the CLI. | -| `CLI_FORCE` | A boolean containing whether the `--force` or `--force-all` flags were set. | -| `TASK` | The name of the current task. | -| `ROOT_DIR` | The absolute path of the root Taskfile. | -| `TASKFILE_DIR` | The absolute path of the included Taskfile. | -| `USER_WORKING_DIR` | The absolute path of the directory `task` was called from. | -| `CHECKSUM` | The checksum of the files listed in `sources`. Only available within the `status` prop and if method is set to `checksum`. | -| `TIMESTAMP` | The date object of the greatest timestamp of the files listed in `sources`. Only available within the `status` prop and if method is set to `timestamp`. | -| `TASK_VERSION` | The current version of task. | -| `ITEM` | The value of the current iteration when using the `for` property. Can be changed to a different variable name using `as:`. | - -## 環境変数 - -Some environment variables can be overridden to adjust Task behavior. - -| 環境変数 | デフォルト値 | 説明 | -| -------------------- | ------- | ----------------------------------------------------------------------------------------------------------------- | -| `TASK_TEMP_DIR` | `.task` | Location of the temp dir. Can relative to the project like `tmp/task` or absolute like `/tmp/.task` or `~/.task`. | -| `TASK_COLOR_RESET` | `0` | 白色に使われる。 | -| `TASK_COLOR_BLUE` | `34` | 青色に使われる。 | -| `TASK_COLOR_GREEN` | `32` | 緑色に使われる。 | -| `TASK_COLOR_CYAN` | `36` | シアン色に使われる。 | -| `TASK_COLOR_YELLOW` | `33` | 黄色に使われる。 | -| `TASK_COLOR_MAGENTA` | `35` | マゼンタ色に使われる。 | -| `TASK_COLOR_RED` | `31` | 赤色に使われる。 | -| `FORCE_COLOR` | | 色の出力を強制します。 | - -## Taskfileのスキーマ - -| 属性 | 型 | デフォルト値 | 説明 | -| ---------- | ---------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `version` | `string` | | Version of the Taskfile. The current version is `3`. | -| `output` | `string` | `interleaved` | Output mode. Available options: `interleaved`, `group` and `prefixed`. | -| `method` | `string` | `checksum` | Default method in this Taskfile. Can be overridden in a task by task basis. Available options: `checksum`, `timestamp` and `none`. | -| `includes` | [`map[string]Include`](#include) | | Additional Taskfiles to be included. | -| `vars` | [`map[string]Variable`](#variable) | | A set of global variables. | -| `env` | [`map[string]Variable`](#variable) | | A set of global environment variables. | -| `tasks` | [`map[string]Task`](#task) | | A set of task definitions. | -| `silent` | `bool` | `false` | Default 'silent' options for this Taskfile. If `false`, can be overridden with `true` in a task by task basis. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `run` | `string` | `always` | Default 'run' option for this Taskfile. Available options: `always`, `once` and `when_changed`. | -| `interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -### Include - -| 属性 | 型 | デフォルト値 | 説明 | -| ---------- | --------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `taskfile` | `string` | | The path for the Taskfile or directory to be included. If a directory, Task will look for files named `Taskfile.yml` or `Taskfile.yaml` inside that directory. If a relative path, resolved relative to the directory containing the including Taskfile. | -| `dir` | `string` | The parent Taskfile directory | The working directory of the included tasks when run. | -| `optional` | `bool` | `false` | If `true`, no errors will be thrown if the specified file does not exist. | -| `internal` | `bool` | `false` | Stops any task in the included Taskfile from being callable on the command line. These commands will also be omitted from the output when used with `--list`. | -| `aliases` | `[]string` | | Alternative names for the namespace of the included Taskfile. | -| `vars` | `map[string]Variable` | | A set of variables to apply to the included Taskfile. | - -:::info - -Informing only a string like below is equivalent to setting that value to the `taskfile` attribute. - -```yaml -includes: - foo: ./path -``` - -::: - -### Variable - -| 属性 | 型 | デフォルト値 | 説明 | -| -------- | -------- | ------ | ------------------------------------------------------------------------ | -| _itself_ | `string` | | A static value that will be set to the variable. | -| `sh` | `string` | | A shell command. The output (`STDOUT`) will be assigned to the variable. | - -:::info - -Static and dynamic variables have different syntaxes, like below: - -```yaml -vars: - STATIC: static - DYNAMIC: - sh: echo "dynamic" -``` - -::: - -### Task - -| 属性 | 型 | デフォルト値 | 説明 | -| --------------- | ---------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmds` | [`[]Command`](#command) | | A list of shell commands to be executed. | -| `deps` | [`[]Dependency`](#dependency) | | A list of dependencies of this task. Tasks defined here will run in parallel before this task. | -| `label` | `string` | | Overrides the name of the task in the output when a task is run. Supports variables. | -| `desc` | `string` | | A short description of the task. This is displayed when calling `task --list`. | -| `prompt` | `string` | | A prompt that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks. | -| `summary` | `string` | | A longer description of the task. This is displayed when calling `task --summary [task]`. | -| `aliases` | `[]string` | | A list of alternative names by which the task can be called. | -| `sources` | `[]string` | | A list of sources to check before running this task. Relevant for `checksum` and `timestamp` methods. Can be file paths or star globs. | -| `generates` | `[]string` | | A list of files meant to be generated by this task. Relevant for `timestamp` method. Can be file paths or star globs. | -| `status` | `[]string` | | A list of commands to check if this task should run. The task is skipped otherwise. This overrides `method`, `sources` and `generates`. | -| `requires` | `[]string` | | A list of variables which should be set if this task is to run, if any of these variables are unset the task will error and not run. | -| `preconditions` | [`[]Precondition`](#precondition) | | A list of commands to check if this task should run. If a condition is not met, the task will error. | -| `requires` | [`Requires`](#requires) | | A list of required variables which should be set if this task is to run, if any variables listed are unset the task will error and not run. | -| `dir` | `string` | | The directory in which this task should run. Defaults to the current working directory. | -| `vars` | [`map[string]Variable`](#variable) | | A set of variables that can be used in the task. | -| `env` | [`map[string]Variable`](#variable) | | A set of environment variables that will be made available to shell commands. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. When combined with the `--list` flag, task descriptions will be hidden. | -| `interactive` | `bool` | `false` | Tells task that the command is interactive. | -| `internal` | `bool` | `false` | Stops a task from being callable on the command line. It will also be omitted from the output when used with `--list`. | -| `method` | `string` | `checksum` | Defines which method is used to check the task is up-to-date. `timestamp` will compare the timestamp of the sources and generates files. `checksum` will check the checksum (You probably want to ignore the .task folder in your .gitignore file). `none` skips any validation and always run the task. | -| `prefix` | `string` | | Defines a string to prefix the output of tasks running in parallel. Only used when the output mode is `prefixed`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing commands. | -| `run` | `string` | The one declared globally in the Taskfile or `always` | Specifies whether the task should run again or not if called more than once. Available options: `always`, `once` and `when_changed`. | -| `platforms` | `[]string` | 全てのプラットフォーム | Specifies which platforms the task should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Task will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -These alternative syntaxes are available. They will set the given values to `cmds` and everything else will be set to their default values: - -```yaml -tasks: - foo: echo "foo" - - foobar: - - echo "foo" - - echo "bar" - - baz: - cmd: echo "baz" -``` - -::: - -#### Command - -| 属性 | 型 | デフォルト値 | 説明 | -| -------------- | ---------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmd` | `string` | | The shell command to be executed. | -| `task` | `string` | | Set this to trigger execution of another task instead of running a command. This cannot be set together with `cmd`. | -| `for` | [`For`](#for) | | Runs the command once for each given value. | -| `silent` | `bool` | `false` | Skips some output for this command. Note that STDOUT and STDERR of the commands will still be redirected. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to the referenced task. Only relevant when setting `task` instead of `cmd`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing the command. | -| `defer` | `string` | | Alternative to `cmd`, but schedules the command to be executed at the end of this task instead of immediately. This cannot be used together with `cmd`. | -| `platforms` | `[]string` | 全てのプラットフォーム | Specifies which platforms the command should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Command will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -If given as a a string, the value will be assigned to `cmd`: - -```yaml -tasks: - foo: - cmds: - - echo "foo" - - echo "bar" -``` - -::: - -#### Dependency - -| 属性 | 型 | デフォルト値 | 説明 | -| -------- | ---------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------- | -| `task` | `string` | | The task to be execute as a dependency. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to this task. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. | - -:::tip - -If you don't want to set additional variables, it's enough to declare the dependency as a list of strings (they will be assigned to `task`): - -```yaml -tasks: - foo: - deps: [foo, bar] -``` - -::: - -#### For - -The `for` parameter can be defined as a string, a list of strings or a map. If it is defined as a string, you can give it any of the following values: - -- `source` - Will run the command for each source file defined on the task. (Glob patterns will be resolved, so `*.go` will run for every Go file that matches). - -If it is defined as a list of strings, the command will be run for each value. - -Finally, the `for` parameter can be defined as a map when you want to use a variable to define the values to loop over: - -| Attribute | Type | Default | Description | -| --------- | -------- | ---------------- | -------------------------------------------- | -| `var` | `string` | | The name of the variable to use as an input. | -| `split` | `string` | (any whitespace) | What string the variable should be split on. | -| `as` | `string` | `ITEM` | The name of the iterator variable. | - -#### Precondition - -| 属性 | 型 | デフォルト値 | 説明 | -| ----- | -------- | ------ | ------------------------------------------------------------------------------------------------------------ | -| `sh` | `string` | | Command to be executed. If a non-zero exit code is returned, the task errors without executing its commands. | -| `msg` | `string` | | Optional message to print if the precondition isn't met. | - -:::tip - -If you don't want to set a different message, you can declare a precondition like this and the value will be assigned to `sh`: - -```yaml -tasks: - foo: - precondition: test -f Taskfile.yml -``` - -::: - -#### 必須 - -| 属性 | 型 | デフォルト値 | 説明 | -| ------ | ---------- | ------ | -------------------------------- | -| `vars` | `[]string` | | タスクが実行されるために設定する必要がある変数や環境変数のリスト | diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/changelog.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/changelog.md deleted file mode 100644 index 628d35e1..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/changelog.md +++ /dev/null @@ -1,573 +0,0 @@ ---- -slug: /changelog/ -sidebar_position: 14 ---- - -# Changelog - -## v3.33.1 - 2023-12-21 - -- Added support for looping over map variables with the [Any Variables experiment](https://taskfile.dev/experiments/any_variables) enabled (#1435, #1437 by @pd93). -- Fixed a bug where dynamic variables were causing errors during fast compilation (#1435, #1437 by @pd93) - -## v3.33.0 - 2023-12-20 - -- Added [Any Variables experiment](https://taskfile.dev/experiments/any-variables) (#1415, #1421 by @pd93). -- Updated Docusaurus to v3 (#1432 by @pd93). -- Added `aliases` to `--json` flag output (#1430, #1431 by @pd93). -- Added new `CLI_FORCE` special variable containing whether the `--force` or `--force-all` flags were set (#1412, #1434 by @pd93). - -## v3.32.0 - 2023-11-29 - -- Added ability to exclude some files from `sources:` by using `exclude:` (#225, - - # 1324 by @pd93 and @andreynering). -- The [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) now prefers remote files over cached ones by default (#1317, #1345 by @pd93). -- Added `--timeout` flag to the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1345 by @pd93). -- Fix bug where dynamic `vars:` and `env:` were being executed when they should actually be skipped by `platforms:` (#1273, #1377 by @andreynering). -- Fix `schema.json` to make `silent` valid in `cmds` that use `for` (#1385, - - # 1386 by @iainvm). -- Add new `--no-status` flag to skip expensive status checks when running `task --list --json` (#1348, #1368 by @amancevice). - -## v3.31.0 - 2023-10-07 - -- Enabled the `--yes` flag for the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1344 by @pd93). -- Add ability to set `watch: true` in a task to automatically run it in watch mode (#231, #1361 by @andreynering). -- Fixed a bug on the watch mode where paths that contained `.git` (like `.github`), for example, were also being ignored (#1356 by @butuzov). -- Fixed a nil pointer error when running a Taskfile with no contents (#1341, - - # 1342 by @pd93). -- Added a new [exit code](https://taskfile.dev/api/#exit-codes) (107) for when a Taskfile does not contain a schema version (#1342 by @pd93). -- Increased limit of maximum task calls from 100 to 1000 for now, as some people have been reaching this limit organically now that we have loops. This check exists to detect recursive calls, but will be removed in favor of a better algorithm soon (#1321, #1332). -- Fixed templating on descriptions on `task --list` (#1343 by @blackjid). -- Fixed a bug where precondition errors were incorrectly being printed when task execution was aborted (#1337, #1338 by @sylv-io). - -## v3.30.1 - 2023-09-14 - -- Fixed a regression where some special variables weren't being set correctly (#1331, #1334 by @pd93). - -## v3.30.0 - 2023-09-13 - -- Prep work for Remote Taskfiles (#1316 by @pd93). -- Added the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) as a draft (#1152, #1317 by @pd93). -- Improve performance of content checksuming on `sources:` by replacing md5 with [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking change because checksums will be invalidated when upgrading to this release (#1325 by @ReillyBrogan). - -## v3.29.1 - 2023-08-26 - -- Update to Go 1.21 (bump minimum version to 1.20) (#1302 by @pd93) -- Fix a missing a line break on log when using `--watch` mode (#1285, #1297 by @FilipSolich). -- Fix `defer` on JSON Schema (#1288 by @calvinmclean and @andreynering). -- Fix bug in usage of special variables like `{{.USER_WORKING_DIR}}` in combination with `includes` (#1046, #1205, #1250, #1293, #1312, #1274 by @andarto, #1309 by @andreynering). -- Fix bug on `--status` flag. Running this flag should not have side-effects: it should not update the checksum on `.task`, only report its status (#1305, - - # 1307 by @visciang, #1313 by @andreynering). - -## v3.28.0 - 2023-07-24 - -- Added the ability to [loop over commands and tasks](https://taskfile.dev/usage/#looping-over-values) using `for` (#82, #1220 by @pd93). -- Fixed variable propagation in multi-level includes (#778, #996, #1256 by @hudclark). -- Fixed a bug where the `--exit-code` code flag was not returning the correct exit code when calling commands indirectly (#1266, #1270 by @pd93). -- Fixed a `nil` panic when a dependency was commented out or left empty (#1263 by @neomantra). - -## v3.27.1 - 2023-06-30 - -- Fix panic when a `.env` directory (not file) is present on current directory (#1244, #1245 by @pd93). - -## v3.27.0 - 2023-06-29 - -- Allow Taskfiles starting with lowercase characters (#947, #1221 by @pd93). - - e.g. `taskfile.yml`, `taskfile.yaml`, `taskfile.dist.yml` & `taskfile.dist.yaml` -- Bug fixes were made to the [npm installation method](https://taskfile.dev/installation/#npm). (#1190, by @sounisi5011). -- Added the [gentle force experiment](https://taskfile.dev/experiments/gentle-force) as a draft (#1200, #1216 by @pd93). -- Added an `--experiments` flag to allow you to see which experiments are enabled (#1242 by @pd93). -- Added ability to specify which variables are required in a task (#1203, #1204 by @benc-uk). - -## v3.26.0 - 2023-06-10 - -- Only rewrite checksum files in `.task` if the checksum has changed (#1185, - - # 1194 by @deviantintegral). -- Added [experiments documentation](https://taskfile.dev/experiments) to the website (#1198 by @pd93). -- Deprecated `version: 2` schema. This will be removed in the next major release (#1197, #1198, #1199 by @pd93). -- Added a new `prompt:` prop to set a warning prompt to be shown before running a potential dangurous task (#100, #1163 by @MaxCheetham, [Documentation](https://taskfile.dev/usage/#warning-prompts)). -- Added support for single command task syntax. With this change, it's now possible to declare just `cmd:` in a task, avoiding the more complex `cmds: []` when you have only a single command for that task (#1130, #1131 by @timdp). - -## v3.25.0 - 2023-05-22 - -- Support `silent:` when calling another tasks (#680, #1142 by @danquah). -- Improve PowerShell completion script (#1168 by @trim21). -- Add more languages to the website menu and show translation progress percentage (#1173 by @misitebao). -- Starting on this release, official binaries for FreeBSD will be available to download (#1068 by @andreynering). -- Fix some errors being unintendedly supressed (#1134 by @clintmod). -- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - - # 1149 by @pd93). -- Fix duplicate error message when a task does not exists (#1141, #1144 by @pd93). - -## v3.24.0 - 2023-04-15 - -- Fix Fish shell completion for tasks with aliases (#1113 by @patricksjackson). -- The default branch was renamed from `master` to `main` (#1049, #1048 by @pd93). -- Fix bug where "up-to-date" logs were not being omitted for silent tasks (#546, - - # 1107 by @danquah). -- Add `.hg` (Mercurial) to the list of ignored directories when using `--watch` (#1098 by @misery). -- More improvements to the release tool (#1096 by @pd93). -- Enforce [gofumpt](https://github.com/mvdan/gofumpt) linter (#1099 by @pd93) -- Add `--sort` flag for use with `--list` and `--list-all` (#946, #1105 by @pd93). -- Task now has [custom exit codes](https://taskfile.dev/api/#exit-codes) depending on the error (#1114 by @pd93). - -## v3.23.0 - 2023-03-26 - -Task now has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task) contributed by @pd93! :tada: The extension is maintained in a [new repository](https://github.com/go-task/vscode-task) under the `go-task` organization. We're looking to gather feedback from the community so please give it a go and let us know what you think via a [discussion](https://github.com/go-task/vscode-task/discussions), [issue](https://github.com/go-task/vscode-task/issues) or on our [Discord](https://discord.gg/6TY36E39UK)! - -> **NOTE:** The extension _requires_ v3.23.0 to be installed in order to work. - -- The website was integrated with [Crowdin](https://crowdin.com/project/taskfile) to allow the community to contribute with translations! [Chinese](https://taskfile.dev/zh-Hans/) is the first language available (#1057, #1058 by @misitebao). -- Added task location data to the `--json` flag output (#1056 by @pd93) -- Change the name of the file generated by `task --init` from `Taskfile.yaml` to `Taskfile.yml` (#1062 by @misitebao). -- Added new `splitArgs` template function (`{{splitArgs "foo bar 'foo bar baz'"}}`) to ensure string is split as arguments (#1040, #1059 by @dhanusaputra). -- Fix the value of `{{.CHECKSUM}}` variable in status (#1076, #1080 by @pd93). -- Fixed deep copy implementation (#1072 by @pd93) -- Created a tool to assist with releases (#1086 by @pd93). - -## v3.22.0 - 2023-03-10 - -- Add a brand new `--global` (`-g`) flag that will run a Taskfile from your `$HOME` directory. This is useful to have automation that you can run from anywhere in your system! ([Documentation](https://taskfile.dev/usage/#running-a-global-taskfile), #1029 by @andreynering). -- Add ability to set `error_only: true` on the `group` output mode. This will instruct Task to only print a command output if it returned with a non-zero exit code (#664, #1022 by @jaedle). -- Fixed bug where `.task/checksum` file was sometimes not being created when task also declares a `status:` (#840, #1035 by @harelwa, #1037 by @pd93). -- Refactored and decoupled fingerprinting from the main Task executor (#1039 by @pd93). -- Fixed deadlock issue when using `run: once` (#715, #1025 by @theunrepentantgeek). - -## v3.21.0 - 2023-02-22 - -- Added new `TASK_VERSION` special variable (#990, #1014 by @ja1code). -- Fixed a bug where tasks were sometimes incorrectly marked as internal (#1007 by @pd93). -- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) -- Added environment variable `FORCE_COLOR` support to force color output. Usefull for environments without TTY (#1003 by @automation-stack) - -## v3.20.0 - 2023-01-14 - -- Improve behavior and performance of status checking when using the `timestamp` mode (#976, #977 by @aminya). -- Performance optimizations were made for large Taskfiles (#982 by @pd93). -- Add ability to configure options for the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins (#908, #929 by @pd93, [Documentation](http://taskfile.dev/usage/#set-and-shopt)). -- Add new `platforms:` attribute to `task` and `cmd`, so it's now possible to choose in which platforms that given task or command will be run on. Possible values are operating system (GOOS), architecture (GOARCH) or a combination of the two. Example: `platforms: [linux]`, `platforms: [amd64]` or `platforms: [linux/amd64]`. Other platforms will be skipped (#978, #980 by @leaanthony). - -## v3.19.1 - 2022-12-31 - -- Small bug fix: closing `Taskfile.yml` once we're done reading it (#963, #964 by @HeCorr). -- Fixes a bug in v2 that caused a panic when using a `Taskfile_{{OS}}.yml` file (#961, #971 by @pd93). -- Fixed a bug where watch intervals set in the Taskfile were not being respected (#969, #970 by @pd93) -- Add `--json` flag (alias `-j`) with the intent to improve support for code editors and add room to other possible integrations. This is basic for now, but we plan to add more info in the near future (#936 by @davidalpert, #764). - -## v3.19.0 - 2022-12-05 - -- Installation via npm now supports [pnpm](https://pnpm.io/) as well ([go-task/go-npm#2](https://github.com/go-task/go-npm/issues/2), [go-task/go-npm#3](https://github.com/go-task/go-npm/pull/3)). -- It's now possible to run Taskfiles from subdirectories! A new `USER_WORKING_DIR` special variable was added to add even more flexibility for monorepos (#289, #920). -- Add task-level `dotenv` support (#389, #904). -- It's now possible to use global level variables on `includes` (#942, #943). -- The website got a brand new [translation to Chinese](https://task-zh.readthedocs.io/zh_CN/latest/) by [@DeronW](https://github.com/DeronW). Thanks! - -## v3.18.0 - 2022-11-12 - -- Show aliases on `task --list --silent` (`task --ls`). This means that aliases will be completed by the completion scripts (#919). -- Tasks in the root Taskfile will now be displayed first in `--list`/`--list-all` output (#806, #890). -- It's now possible to call a `default` task in an included Taskfile by using just the namespace. For example: `docs:default` is now automatically aliased to `docs` (#661, #815). - -## v3.17.0 - 2022-10-14 - -- Add a "Did you mean ...?" suggestion when a task does not exits another one with a similar name is found (#867, #880). -- Now YAML parse errors will print which Taskfile failed to parse (#885, #887). -- Add ability to set `aliases` for tasks and namespaces (#268, #340, #879). -- Improvements to Fish shell completion (#897). -- Added ability to set a different watch interval by setting `interval: '500ms'` or using the `--interval=500ms` flag (#813, #865). -- Add colored output to `--list`, `--list-all` and `--summary` flags (#845, - - # 874). -- Fix unexpected behavior where `label:` was being shown instead of the task name on `--list` (#603, #877). - -## v3.16.0 - 2022-09-29 - -- Add `npm` as new installation method: `npm i -g @go-task/cli` (#870, #871, [npm package](https://www.npmjs.com/package/@go-task/cli)). -- Add support to marking tasks and includes as internal, which will hide them from `--list` and `--list-all` (#818). - -## v3.15.2 - 2022-09-08 - -- Fix error when using variable in `env:` introduced in the previous release (#858, #866). -- Fix handling of `CLI_ARGS` (`--`) in Bash completion (#863). -- On zsh completion, add ability to replace `--list-all` with `--list` as already possible on the Bash completion (#861). - -## v3.15.0 - 2022-09-03 - -- Add new special variables `ROOT_DIR` and `TASKFILE_DIR`. This was a highly requested feature (#215, #857, [Documentation](https://taskfile.dev/api/#special-variables)). -- Follow symlinks on `sources` (#826, #831). -- Improvements and fixes to Bash completion (#835, #844). - -## v3.14.1 - 2022-08-03 - -- Always resolve relative include paths relative to the including Taskfile (#822, #823). -- Fix ZSH and PowerShell completions to consider all tasks instead of just the public ones (those with descriptions) (#803). - -## v3.14.0 - 2022-07-08 - -- Add ability to override the `.task` directory location with the `TASK_TEMP_DIR` environment variable. -- Allow to override Task colors using environment variables: `TASK_COLOR_RESET`, `TASK_COLOR_BLUE`, `TASK_COLOR_GREEN`, `TASK_COLOR_CYAN`, `TASK_COLOR_YELLOW`, `TASK_COLOR_MAGENTA` and `TASK_COLOR_RED` (#568, #792). -- Fixed bug when using the `output: group` mode where STDOUT and STDERR were being print in separated blocks instead of in the right order (#779). -- Starting on this release, ARM architecture binaries are been released to Snap as well (#795). -- i386 binaries won't be available anymore on Snap because Ubuntu removed the support for this architecture. -- Upgrade mvdan.cc/sh, which fixes a bug with associative arrays (#785, [mvdan/sh#884](https://github.com/mvdan/sh/issues/884), [mvdan/sh#893](https://github.com/mvdan/sh/pull/893)). - -## v3.13.0 - 2022-06-13 - -- Added `-n` as an alias to `--dry` (#776, #777). -- Fix behavior of interrupt (SIGINT, SIGTERM) signals. Task will now give time for the processes running to do cleanup work (#458, #479, #728, #769). -- Add new `--exit-code` (`-x`) flag that will pass-through the exit form the command being ran (#755). - -## v3.12.1 - 2022-05-10 - -- Fixed bug where, on Windows, variables were ending with `\r` because we were only removing the final `\n` but not `\r\n` (#717). - -## v3.12.0 - 2022-03-31 - -- The `--list` and `--list-all` flags can now be combined with the `--silent` flag to print the task names only, without their description (#691). -- Added support for multi-level inclusion of Taskfiles. This means that included Taskfiles can also include other Taskfiles. Before this was limited to one level (#390, #623, #656). -- Add ability to specify vars when including a Taskfile. [Check out the documentation](https://taskfile.dev/#/usage?id=vars-of-included-taskfiles) for more information (#677). - -## v3.11.0 - 2022-02-19 - -- Task now supports printing begin and end messages when using the `group` output mode, useful for grouping tasks in CI systems. [Check out the documentation](http://taskfile.dev/#/usage?id=output-syntax) for more information (#647, #651). -- Add `Taskfile.dist.yml` and `Taskfile.dist.yaml` to the supported file name list. [Check out the documentation](https://taskfile.dev/#/usage?id=supported-file-names) for more information (#498, #666). - -## v3.10.0 - 2022-01-04 - -- A new `--list-all` (alias `-a`) flag is now available. It's similar to the exiting `--list` (`-l`) but prints all tasks, even those without a description (#383, #401). -- It's now possible to schedule cleanup commands to run once a task finishes with the `defer:` keyword ([Documentation](https://taskfile.dev/#/usage?id=doing-task-cleanup-with-defer), - - # 475, #626). -- Remove long deprecated and undocumented `$` variable prefix and `^` command prefix (#642, #644, #645). -- Add support for `.yaml` extension (as an alternative to `.yml`). This was requested multiple times throughout the years. Enjoy! (#183, #184, #369, #584, - - # 621). -- Fixed error when computing a variable when the task directory do not exist yet (#481, #579). - -## v3.9.2 - 2021-12-02 - -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains a fix a for a important regression on Windows (#619, [mvdan/sh#768](https://github.com/mvdan/sh/issues/768), [mvdan/sh#769](https://github.com/mvdan/sh/pull/769)). - -## v3.9.1 - 2021-11-28 - -- Add logging in verbose mode for when a task starts and finishes (#533, #588). -- Fix an issue with preconditions and context errors (#597, #598). -- Quote each `{{.CLI_ARGS}}` argument to prevent one with spaces to become many (#613). -- Fix nil pointer when `cmd:` was left empty (#612, #614). -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains two relevant fixes: - - Fix quote of empty strings in `shellQuote` (#609, [mvdan/sh#763](https://github.com/mvdan/sh/issues/763)). - - Fix issue of wrong environment variable being picked when there's another very similar one (#586, [mvdan/sh#745](https://github.com/mvdan/sh/pull/745)). -- Install shell completions automatically when installing via Homebrew (#264, #592, [go-task/homebrew-tap#2](https://github.com/go-task/homebrew-tap/pull/2)). - -## v3.9.0 - 2021-10-02 - -- A new `shellQuote` function was added to the template system (`{{shellQuote "a string"}}`) to ensure a string is safe for use in shell ([mvdan/sh#727](https://github.com/mvdan/sh/pull/727), [mvdan/sh#737](https://github.com/mvdan/sh/pull/737), [Documentation](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)) -- In this version [mvdan.cc/sh](https://github.com/mvdan/sh) was upgraded with some small fixes and features - - The `read -p` flag is now supported (#314, [mvdan/sh#551](https://github.com/mvdan/sh/issues/551), [mvdan/sh#772](https://github.com/mvdan/sh/pull/722)) - - The `pwd -P` and `pwd -L` flags are now supported (#553, [mvdan/sh#724](https://github.com/mvdan/sh/issues/724), [mvdan/sh#728](https://github.com/mvdan/sh/pull/728)) - - The `$GID` environment variable is now correctly being set (#561, [mvdan/sh#723](https://github.com/mvdan/sh/pull/723)) - -## v3.8.0 - 2021-09-26 - -- Add `interactive: true` setting to improve support for interactive CLI apps (#217, #563). -- Fix some `nil` errors (#534, #573). -- Add ability to declare an included Taskfile as optional (#519, #552). -- Add support for including Taskfiles in the home directory by using `~` (#539, #557). - -## v3.7.3 - 2021-09-04 - -- Add official support to Apple M1 (#564, #567). -- Our [official Homebrew tap](https://github.com/go-task/homebrew-tap) will support more platforms, including Apple M1 - -## v3.7.0 - 2021-07-31 - -- Add `run:` setting to control if tasks should run multiple times or not. Available options are `always` (the default), `when_changed` (if a variable modified the task) and `once` (run only once no matter what). This is a long time requested feature. Enjoy! (#53, #359). - -## v3.6.0 - 2021-07-10 - -- Allow using both `sources:` and `status:` in the same task (#411, #427, #477). -- Small optimization and bug fix: don't compute variables if not needed for `dotenv:` (#517). - -## v3.5.0 - 2021-07-04 - -- Add support for interpolation in `dotenv:` (#433, #434, #453). - -## v3.4.3 - 2021-05-30 - -- Add support for the `NO_COLOR` environment variable. (#459, [fatih/color#137](https://github.com/fatih/color/pull/137)). -- Fix bug where sources were not considering the right directory in `--watch` mode (#484, #485). - -## v3.4.2 - 2021-04-23 - -- On watch, report which file failed to read (#472). -- Do not try to catch SIGKILL signal, which are not actually possible (#476). -- Improve version reporting when building Task from source using Go Modules (#462, #473). - -## v3.4.1 - 2021-04-17 - -- Improve error reporting when parsing YAML: in some situations where you would just see an generic error, you'll now see the actual error with more detail: the YAML line the failed to parse, for example (#467). -- A JSON Schema was published [here](https://json.schemastore.org/taskfile.json) and is automatically being used by some editors like Visual Studio Code (#135). -- Print task name before the command in the log output (#398). - -## v3.3.0 - 2021-03-20 - -- Add support for delegating CLI arguments to commands with `--` and a special `CLI_ARGS` variable (#327). -- Add a `--concurrency` (alias `-C`) flag, to limit the number of tasks that run concurrently. This is useful for heavy workloads. (#345). - -## v3.2.2 - 2021-01-12 - -- Improve performance of `--list` and `--summary` by skipping running shell variables for these flags (#332). -- Fixed a bug where an environment in a Taskfile was not always overridable by the system environment (#425). -- Fixed environment from .env files not being available as variables (#379). -- The install script is now working for ARM platforms (#428). - -## v3.2.1 - 2021-01-09 - -- Fixed some bugs and regressions regarding dynamic variables and directories (#426). -- The [slim-sprig](https://github.com/go-task/slim-sprig) package was updated with the upstream [sprig](https://github.com/Masterminds/sprig). - -## v3.2.0 - 2021-01-07 - -- Fix the `.task` directory being created in the task directory instead of the Taskfile directory (#247). -- Fix a bug where dynamic variables (those declared with `sh:`) were not running in the task directory when the task has a custom dir or it was in an included Taskfile (#384). -- The watch feature (via the `--watch` flag) got a few different bug fixes and should be more stable now (#423, #365). - -## v3.1.0 - 2021-01-03 - -- Fix a bug when the checksum up-to-date resolution is used by a task with a custom `label:` attribute (#412). -- Starting from this release, we're releasing official ARMv6 and ARM64 binaries for Linux (#375, #418). -- Task now respects the order of declaration of included Taskfiles when evaluating variables declaring by them (#393). -- `set -e` is now automatically set on every command. This was done to fix an issue where multiline string commands wouldn't really fail unless the sentence was in the last line (#403). - -## v3.0.1 - 2020-12-26 - -- Allow use as a library by moving the required packages out of the `internal` directory (#358). -- Do not error if a specified dotenv file does not exist (#378, #385). -- Fix panic when you have empty tasks in your Taskfile (#338, #362). - -## v3.0.0 - 2020-08-16 - -- On `v3`, all CLI variables will be considered global variables (#336, #341) -- Add support to `.env` like files (#324, #356). -- Add `label:` to task so you can override the task name in the logs (#321, - - # 337). -- Refactor how variables work on version 3 (#311). -- Disallow `expansions` on v3 since it has no effect. -- `Taskvars.yml` is not automatically included anymore. -- `Taskfile_{{OS}}.yml` is not automatically included anymore. -- Allow interpolation on `includes`, so you can manually include a Taskfile based on operation system, for example. -- Expose `.TASK` variable in templates with the task name (#252). -- Implement short task syntax (#194, #240). -- Added option to make included Taskfile run commands on its own directory (#260, #144) -- Taskfiles in version 1 are not supported anymore (#237). -- Added global `method:` option. With this option, you can set a default method to all tasks in a Taskfile (#246). -- Changed default method from `timestamp` to `checksum` (#246). -- New magic variables are now available when using `status:`: `.TIMESTAMP` which contains the greatest modification date from the files listed in `sources:`, and `.CHECKSUM`, which contains a checksum of all files listed in `status:`. This is useful for manual checking when using external, or even remote, artifacts when using `status:` (#216). -- We're now using [slim-sprig](https://github.com/go-task/slim-sprig) instead of [sprig](https://github.com/Masterminds/sprig), which allowed a file size reduction of about 22% (#219). -- We now use some colors on Task output to better distinguish message types - commands are green, errors are red, etc (#207). - -## v2.8.1 - 2020-05-20 - -- Fix error code for the `--help` flag (#300, #330). -- Print version to stdout instead of stderr (#299, #329). -- Supress `context` errors when using the `--watch` flag (#313, #317). -- Support templating on description (#276, #283). - -## v2.8.0 - 2019-12-07 - -- Add `--parallel` flag (alias `-p`) to run tasks given by the command line in parallel (#266). -- Fixed bug where calling the `task` CLI only informing global vars would not execute the `default` task. -- Add hability to silent all tasks by adding `silent: true` a the root of the Taskfile. - -## v2.7.1 - 2019-11-10 - -- Fix error being raised when `exit 0` was called (#251). - -## v2.7.0 - 2019-09-22 - -- Fixed panic bug when assigning a global variable (#229, #243). -- A task with `method: checksum` will now re-run if generated files are deleted (#228, #238). - -## v2.6.0 - 2019-07-21 - -- Fixed some bugs regarding minor version checks on `version:`. -- Add `preconditions:` to task (#205). -- Create directory informed on `dir:` if it doesn't exist (#209, #211). -- We now have a `--taskfile` flag (alias `-t`), which can be used to run another Taskfile (other than the default `Taskfile.yml`) (#221). -- It's now possible to install Task using Homebrew on Linux ([go-task/homebrew-tap#1](https://github.com/go-task/homebrew-tap/pull/1)). - -## v2.5.2 - 2019-05-11 - -- Reverted YAML upgrade due issues with CRLF on Windows (#201, [go-yaml/yaml#450](https://github.com/go-yaml/yaml/issues/450)). -- Allow setting global variables through the CLI (#192). - -## 2.5.1 - 2019-04-27 - -- Fixed some issues with interactive command line tools, where sometimes the output were not being shown, and similar issues (#114, #190, #200). -- Upgraded [go-yaml/yaml](https://github.com/go-yaml/yaml) from v2 to v3. - -## v2.5.0 - 2019-03-16 - -- We moved from the taskfile.org domain to the new fancy taskfile.dev domain. While stuff is being redirected, we strongly recommend to everyone that use [this install script](https://taskfile.dev/#/installation?id=install-script) to use the new taskfile.dev domain on scripts from now on. -- Fixed to the ZSH completion (#182). -- Add [`--summary` flag along with `summary:` task attribute](https://taskfile.org/#/usage?id=display-summary-of-task) (#180). - -## v2.4.0 - 2019-02-21 - -- Allow calling a task of the root Taskfile from an included Taskfile by prefixing it with `:` (#161, #172). -- Add flag to override the `output` option (#173). -- Fix bug where Task was persisting the new checksum on the disk when the Dry Mode is enabled (#166). -- Fix file timestamp issue when the file name has spaces (#176). -- Mitigating path expanding issues on Windows (#170). - -## v2.3.0 - 2019-01-02 - -- On Windows, Task can now be installed using [Scoop](https://scoop.sh/) (#152). -- Fixed issue with file/directory globing (#153). -- Added ability to globally set environment variables (#138, #159). - -## v2.2.1 - 2018-12-09 - -- This repository now uses Go Modules (#143). We'll still keep the `vendor` directory in sync for some time, though; -- Fixing a bug when the Taskfile has no tasks but includes another Taskfile (#150); -- Fix a bug when calling another task or a dependency in an included Taskfile (#151). - -## v2.2.0 - 2018-10-25 - -- Added support for [including other Taskfiles](https://taskfile.org/#/usage?id=including-other-taskfiles) (#98) - - This should be considered experimental. For now, only including local files is supported, but support for including remote Taskfiles is being discussed. If you have any feedback, please comment on #98. -- Task now have a dedicated documentation site: https://taskfile.org - - Thanks to [Docsify](https://docsify.js.org/) for making this pretty easy. To check the source code, just take a look at the [docs](https://github.com/go-task/task/tree/main/docs) directory of this repository. Contributions to the documentation is really appreciated. - -## v2.1.1 - 2018-09-17 - -- Fix suggestion to use `task --init` not being shown anymore (when a `Taskfile.yml` is not found) -- Fix error when using checksum method and no file exists for a source glob (#131) -- Fix signal handling when the `--watch` flag is given (#132) - -## v2.1.0 - 2018-08-19 - -- Add a `ignore_error` option to task and command (#123) -- Add a dry run mode (`--dry` flag) (#126) - -## v2.0.3 - 2018-06-24 - -- Expand environment variables on "dir", "sources" and "generates" (#116) -- Fix YAML merging syntax (#112) -- Add ZSH completion (#111) -- Implement new `output` option. Please check out the [documentation](https://github.com/go-task/task#output-syntax) - -## v2.0.2 - 2018-05-01 - -- Fix merging of YAML anchors (#112) - -## v2.0.1 - 2018-03-11 - -- Fixes panic on `task --list` - -## v2.0.0 - 2018-03-08 - -Version 2.0.0 is here, with a new Taskfile format. - -Please, make sure to read the [Taskfile versions](https://github.com/go-task/task/blob/main/TASKFILE_VERSIONS.md) document, since it describes in depth what changed for this version. - -- New Taskfile version 2 (#77) -- Possibility to have global variables in the `Taskfile.yml` instead of `Taskvars.yml` (#66) -- Small improvements and fixes - -## v1.4.4 - 2017-11-19 - -- Handle SIGINT and SIGTERM (#75); -- List: print message with there's no task with description; -- Expand home dir ("~" symbol) on paths (#74); -- Add Snap as an installation method; -- Move examples to its own repo; -- Watch: also walk on tasks called on on "cmds", and not only on "deps"; -- Print logs to stderr instead of stdout (#68); -- Remove deprecated `set` keyword; -- Add checksum based status check, alternative to timestamp based. - -## v1.4.3 - 2017-09-07 - -- Allow assigning variables to tasks at run time via CLI (#33) -- Added suport for multiline variables from sh (#64) -- Fixes env: remove square braces and evaluate shell (#62) -- Watch: change watch library and few fixes and improvements -- When use watching, cancel and restart long running process on file change (#59 and #60) - -## v1.4.2 - 2017-07-30 - -- Flag to set directory of execution -- Always echo command if is verbose mode -- Add silent mode to disable echoing of commands -- Fixes and improvements of variables (#56) - -## v1.4.1 - 2017-07-15 - -- Allow use of YAML for dynamic variables instead of $ prefix - - `VAR: {sh: echo Hello}` instead of `VAR: $echo Hello` -- Add `--list` (or `-l`) flag to print existing tasks -- OS specific Taskvars file (e.g. `Taskvars_windows.yml`, `Taskvars_linux.yml`, etc) -- Consider task up-to-date on equal timestamps (#49) -- Allow absolute path in generates section (#48) -- Bugfix: allow templating when calling deps (#42) -- Fix panic for invalid task in cyclic dep detection -- Better error output for dynamic variables in Taskvars.yml (#41) -- Allow template evaluation in parameters - -## v1.4.0 - 2017-07-06 - -- Cache dynamic variables -- Add verbose mode (`-v` flag) -- Support to task parameters (overriding vars) (#31) (#32) -- Print command, also when "set:" is specified (#35) -- Improve task command help text (#35) - -## v1.3.1 - 2017-06-14 - -- Fix glob not working on commands (#28) -- Add ExeExt template function -- Add `--init` flag to create a new Taskfile -- Add status option to prevent task from running (#27) -- Allow interpolation on `generates` and `sources` attributes (#26) - -## v1.3.0 - 2017-04-24 - -- Migrate from os/exec.Cmd to a native Go sh/bash interpreter - - This is a potentially breaking change if you use Windows. - - Now, `cmd` is not used anymore on Windows. Always use Bash-like syntax for your commands, even on Windows. -- Add "ToSlash" and "FromSlash" to template functions -- Use functions defined on github.com/Masterminds/sprig -- Do not redirect stdin while running variables commands -- Using `context` and `errgroup` packages (this will make other tasks to be cancelled, if one returned an error) - -## v1.2.0 - 2017-04-02 - -- More tests and Travis integration -- Watch a task (experimental) -- Possibility to call another task -- Fix "=" not being reconized in variables/environment variables -- Tasks can now have a description, and help will print them (#10) -- Task dependencies now run concurrently -- Support for a default task (#16) - -## v1.1.0 - 2017-03-08 - -- Support for YAML, TOML and JSON (#1) -- Support running command in another directory (#4) -- `--force` or `-f` flag to force execution of task even when it's up-to-date -- Detection of cyclic dependencies (#5) -- Support for variables (#6, #9, #14) -- Operation System specific commands and variables (#13) - -## v1.0.0 - 2017-02-28 - -- Add LICENSE file diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/community.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/community.md deleted file mode 100644 index c069c2be..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/community.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -slug: /community/ -sidebar_position: 9 ---- - -# Community - -Some of the work to improve the Task ecosystem is done by the community, be it installation methods or integrations with code editor. I (the author) am thankful for everyone that helps me to improve the overall experience. - -## Translations - -We use [Crowdin](https://crowdin.com/project/taskfile) to translate our document. - -## Integrations - -Many of our integrations are contributed and maintained by the community. You can view the full list of community integrations [here](/integrations#community-integrations). - -## Installation methods - -Some installation methods are maintained by third party: - -- [GitHub Actions](https://github.com/arduino/setup-task) by @arduino -- [AUR](https://aur.archlinux.org/packages/go-task-bin) by @carlsmedstad -- [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json) -- [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) -- [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/go-task/default.nix) -- [Conda](https://github.com/conda-forge/go-task-feedstock/) - -## More - -Also, thanks for all the [code contributors](https://github.com/go-task/task/graphs/contributors), [financial contributors](https://opencollective.com/task), all those who [reported bugs](https://github.com/go-task/task/issues?q=is%3Aissue) and [answered questions](https://github.com/go-task/task/discussions). - -If you know something that is missing in this document, please submit a pull request. diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/contributing.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/contributing.md deleted file mode 100644 index 18720e72..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/contributing.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -slug: /contributing/ -sidebar_position: 11 ---- - -# コントリビュート - -Contributions to Task are very welcome, but we ask that you read this document before submitting a PR. - -:::note - -This document applies to the core [Task][task] repository _and_ [Task for Visual Studio Code][vscode-task]. - -::: - -## 始める前に - -- **Check existing work** - Is there an existing PR? Are there issues discussing the feature/change you want to make? Please make sure you consider/address these discussions in your work. -- **Backwards compatibility** - Will your change break existing Taskfiles? It is much more likely that your change will merged if it backwards compatible. Is there an approach you can take that maintains this compatibility? If not, consider opening an issue first so that API changes can be discussed before you invest your time into a PR. -- **Experiments** - If there is no way to make your change backward compatible then there is a procedure to introduce breaking changes into minor versions. We call these "\[experiments\]\[experiments\]". If you're intending to work on an experiment, then please read the \[experiments workflow\]\[experiments-workflow\] document carefully and submit a proposal first. - -## 1. セットアップ - -- **Go** - Taskは[Go][go]で書かれています。 We always support the latest two major Go versions, so make sure your version is recent enough. -- **Node.js** - [Node.js][nodejs] is used to host Task's documentation server and is required if you want to run this server locally. It is also required if you want to contribute to the Visual Studio Code extension. -- **Yarn** - [Yarn][yarn] is the Node.js package manager used by Task. - -## 2. 変更を加える - -- **Code style** - Try to maintain the existing code style where possible. Go code should be formatted by [`gofumpt`][gofumpt] and linted using [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be formatted and linted by [Prettier][prettier]. This style is enforced by our CI to ensure that we have a consistent style across the project. You can use the `task lint` command to lint the code locally and the `task lint:fix` command to automatically fix any issues that are found. -- **Documentation** - Ensure that you add/update any relevant documentation. See the [updating documentation](#updating-documentation) section below. -- **Tests** - Ensure that you add/update any relevant tests and that all tests are passing before submitting the PR. See the [writing tests](#writing-tests) section below. - -### Running your changes - -To run Task with working changes, you can use `go run ./cmd/task`. To run a development build of task against a test Taskfile in `testdata`, you can use `go run ./cmd/task --dir ./testdata/ `. - -To run Task for Visual Studio Code, you can open the project in VSCode and hit F5 (or whatever you debug keybind is set to). This will open a new VSCode window with the extension running. Debugging this way is recommended as it will allow you to set breakpoints and step through the code. Otherwise, you can run `task package` which will generate a `.vsix` file that can be used to manually install the extension. - -### ドキュメントの更新 - -Task uses [Docusaurus][docusaurus] to host a documentation server. The code for this is located in the core Task repository. This can be setup and run locally by using `task docs` (requires `nodejs` & `yarn`). All content is written in Markdown and is located in the `docs/docs` directory. All Markdown documents should have an 80 character line wrap limit (enforced by Prettier). - -When making a change, consider whether a change to the [Usage Guide](/usage) is necessary. This document contains descriptions and examples of how to use Task features. If you're adding a new feature, try to find an appropriate place to add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](/styleguide). - -If you added a new field, command or flag, ensure that you add it to the [API Reference](/api). New fields also need to be added to the [JSON Schema][json-schema]. The descriptions for fields in the API reference and the schema should match. - -### Writing tests - -A lot of Task's tests are held in the `task_test.go` file in the project root and this is where you'll most likely want to add new ones too. Most of these tests also have a subdirectory in the `testdata` directory where any Taskfiles/data required to run the tests are stored. - -When making a changes, consider whether new tests are required. These tests should ensure that the functionality you are adding will continue to work in the future. Existing tests may also need updating if you have changed Task's behavior. - -You may also consider adding unit tests for any new functions you have added. The unit tests should follow the Go convention of being location in a file named `*_test.go` in the same package as the code being tested. - -## 3. Committing your code - -Try to write meaningful commit messages and avoid having too many commits on the PR. Most PRs should likely have a single commit (although for bigger PRs it may be reasonable to split it in a few). Git squash and rebase is your friend! - -If you're not sure how to format your commit message, check out [Conventional Commits][conventional-commits]. This style is not enforced, but it is a good way to make your commit messages more readable and consistent. - -## 4. Submitting a PR - -- **Describe your changes** - Ensure that you provide a comprehensive description of your changes. -- **Issue/PR links** - Link any previous work such as related issues or PRs. Please describe how your changes differ to/extend this work. -- **Examples** - Add any examples or screenshots that you think are useful to demonstrate the effect of your changes. -- **Draft PRs** - If your changes are incomplete, but you would like to discuss them, open the PR as a draft and add a comment to start a discussion. Using comments rather than the PR description allows the description to be updated later while preserving any discussions. - -## FAQ - -> コントリビュートしたいのですが、どうすればいいですか？ - -Take a look at the list of [open issues for Task][task-open-issues] or [Task for Visual Studio Code][vscode-task-open-issues]. We have a [good first issue][good-first-issue] label for simpler issues that are ideal for first time contributions. - -All kinds of contributions are welcome, whether its a typo fix or a shiny new feature. You can also contribute by upvoting/commenting on issues, helping to answer questions or contributing to other [community projects](/community). - -> I'm stuck, where can I get help? - -If you have questions, feel free to ask them in the `#help` forum channel on our [Discord server][discord-server] or open a [Discussion][discussion] on GitHub. - ---- - - - - -[task]: https://github.com/go-task/task -[vscode-task]: https://github.com/go-task/vscode-task -[go]: https://go.dev -[gofumpt]: https://github.com/mvdan/gofumpt -[golangci-lint]: https://golangci-lint.run -[prettier]: https://prettier.io -[nodejs]: https://nodejs.org/en/ -[yarn]: https://yarnpkg.com/ -[docusaurus]: https://docusaurus.io -[json-schema]: https://github.com/go-task/task/blob/main/docs/static/schema.json -[task-open-issues]: https://github.com/go-task/task/issues -[vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues -[good-first-issue]: https://github.com/go-task/task/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 -[discord-server]: https://discord.gg/6TY36E39UK -[discussion]: https://github.com/go-task/task/discussions -[conventional-commits]: https://www.conventionalcommits.org diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/deprecations/deprecations.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/deprecations/deprecations.md deleted file mode 100644 index 965b26d1..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/deprecations/deprecations.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: /deprecations/ -sidebar_position: 7 ---- - -# Deprecations - -As Task evolves, it occasionally outgrows some of its functionality. This can be because they are no longer useful, because another feature has replaced it or because of a change in the way that Task works internally. - -When this happens, we mark the functionality as deprecated. This means that it will be removed in a future version of Task. This functionality will continue to work until that time, but we strongly recommend that you do not implement this functionality in new Taskfiles and make a plan to migrate away from it as soon as possible. - -You can view a full list of active deprecations in the "Deprecations" section of the sidebar. diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/deprecations/template.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/deprecations/template.md deleted file mode 100644 index 646e45c6..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/deprecations/template.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Deprecated Feature\} (#\{Issue\}) - -:::warning - -This deprecation breaks the following functionality: - -- \{list any existing functionality that will be broken by this deprecation\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -\{Short description of the feature/behavior and why it is being deprecated\} - -\{Short explanation of any replacement features/behaviors and how users should migrate to it\} diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md deleted file mode 100644 index c45fb65d..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -slug: /deprecations/version-2-schema/ ---- - -# Version 2 Schema (#1197) - -:::warning - -This deprecation breaks the following functionality: - -- Any Taskfiles that use the version 2 schema -- `Taskvar.yml` files - -::: - -The Taskfile version 2 schema was introduced in March 2018 and replaced by version 3 in August 2019. In May 2023 [we published a deprecation notice][deprecation-notice] for the version 2 schema on the basis that the vast majority of users had already upgraded to version 3 and removing support for version 2 would allow us to tidy up the codebase and focus on new functionality instead. - -In December 2023, the final version of Task that supports the version 2 schema ([v3.33.0][v3.33.0]) was published and all legacy code was removed from Task's main branch. To use a more recent version of Task, you will need to ensure that your Taskfile uses the version 3 schema instead. A list of changes between version 2 and version 3 are available in the [Task v3 Release Notes][v3.0.0]. - - - - -[v3.0.0]: https://github.com/go-task/task/releases/tag/v3.0.0 -[v3.33.0]: https://github.com/go-task/task/releases/tag/v3.33.0 -[deprecation-notice]: https://github.com/go-task/task/issues/1197 diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/donate.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/donate.md deleted file mode 100644 index 6789533f..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/donate.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: /donate/ -sidebar_position: 16 ---- - -# 寄付 - -If you find this project useful, you can consider donating by using one of the channels listed below. - -This is just a way of saying "thank you", it won't give you any benefits like higher priority on issues or something similar. - -Companies who donate at least $50/month will be featured as a "Gold Sponsor" in the website homepage and on the GitHub repository README. Make contact with [@andreynering][] with the logo you want to be shown. Suspect businesses (gambling, casinos, etc) won't be allowed, though. - -## GitHub Sponsors - -The preferred way to donate to the maintainers is via GitHub Sponsors. Just use the following links to do your donation. We suggest a 50/50 split to each maintainer of the total amount you plan to donate to the project. - -- [@andreynering](https://github.com/sponsors/andreynering) -- [@pd93](https://github.com/sponsors/pd93) - -## Open Collective - -If you prefer [Open Collective](https://opencollective.com/task) you can donate by using these links: - -- [$2 per month](https://opencollective.com/task/contribute/backer-4034/checkout) -- [$5 per month](https://opencollective.com/task/contribute/supporter-8404/checkout) -- [$20 per month](https://opencollective.com/task/contribute/sponsor-4035/checkout) -- [$50 per month](https://opencollective.com/task/contribute/sponsor-28775/checkout) -- [Custom value - One-time donation option supported](https://opencollective.com/task/donate) - -## PayPal - -You can donate to [@andreynering][] via PayPal as well: - -- [Any value - One-time donation](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GSVDU63RKG45A¤cy_code=USD&source=url) - -## PIX (ブラジルのみ) - -And if you're Brazilian, you can also donate to [@andreynering][] via PIX by [using this QR Code](/img/pix.png). - - - - -[@andreynering]: https://github.com/andreynering diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/any_variables.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/any_variables.md deleted file mode 100644 index cf2521c7..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/any_variables.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables (#1415) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any -time_. We strongly recommend that you do not use these features in a production -environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- Dynamically defined variables (using the `sh` keyword) - -::: - -:::info - -To enable this experiment, set the environment variable: -`TASK_X_ANY_VARIABLES=1`. Check out [our guide to enabling experiments -][enabling-experiments] for more information. - -::: - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the [slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for "collection-type" variables, the `for` -keyword has been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -This also works for maps. When looping over a map we also make an additional -`{{.KEY}}` variable availabe that holds the string value of the map key. -Remember that maps are unordered, so the order in which the items are looped -over is random: - -```yaml -version: 3 - -tasks: - foo: - vars: - MAP: - KEY_1: - SUBKEY: sub_value_1 - KEY_2: - SUBKEY: sub_value_2 - KEY_3: - SUBKEY: sub_value_3 - cmds: - - for: - var: MAP - cmd: echo {{.KEY}} {{.ITEM.SUBKEY}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[enabling-experiments]: /experiments/#enabling-experiments - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx deleted file mode 100644 index 73cdcd80..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables - -- Issue: #1415 -- Environment variable: `TASK_X_ANY_VARIABLES=1` -- Breaks: - - Dynamically defined variables (using the `sh` keyword) - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the -[slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for array variables, the `for` keyword has -been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/experiments.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/experiments.md deleted file mode 100644 index b1a70473..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/experiments.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -slug: /experiments/ -sidebar_position: 6 ---- - -# Experiments - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -In order to allow Task to evolve quickly, we roll out breaking changes to minor versions behind experimental flags. This allows us to gather feedback on breaking changes before committing to a major release. This document describes the current set of experimental features and their status in the [workflow](#workflow). - -You can view a full list of active experiments in the "Experiments" section of the sidebar. - -## Enabling Experiments - -You can enable an experimental feature by doing one of the following: - -1. Using the relevant environment variable in front of a task command. For example, `TASK_X_{FEATURE}=1 task {my-task}`. This is intended for one-off invocations of Task to test out experimental features. -1. Using the relevant environment variable in your "dotfiles" (e.g. `.bashrc`, `.zshrc` etc.). This is intended for permanently enabling experimental features in your environment. -1. Creating a `.env` file in the same directory as your root Taskfile that contains the relevant environment variables. This allows you to enable an experimental feature at a project level. For example: - -```shell title=".env" -TASK_X_FEATURE=1 -``` - -## Current Experimental Features and Deprecations - -Each section below details an experiment or deprecation and explains what the flags/environment variables to enable the experiment are and how the feature's behavior will change. It will also explain what you need to do to migrate any existing Taskfiles to the new behavior. - -## Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -### 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -### 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -### 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -### 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -### 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -### Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/gentle_force.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/gentle_force.md deleted file mode 100644 index 514602bb..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/gentle_force.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -slug: /experiments/gentle-force/ ---- - -# Gentle Force (#1200) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- The `--force` flag - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_FORCE=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -The `--force` flag currently forces _all_ tasks to run regardless of the status checks. This can be useful, but we have found that most of the time users only expect the direct task they are calling to be forced and _not_ all of its dependant tasks. - -This experiment changes the `--force` flag to only force the directly called task. All dependant tasks will have their statuses checked as normal and will only run if Task considers them to be out of date. A new `--force-all` flag will also be added to maintain the current behavior for users that need this functionality. - -If you want to migrate, but continue to force all dependant tasks to run, you should replace all uses of the `--force` flag with `--force-all`. Alternatively, if you want to adopt the new behavior, you can continue to use the `--force` flag as you do now! - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md deleted file mode 100644 index 73a934d8..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -slug: /experiments/remote-taskfiles/ ---- - -# Remote Taskfiles (#1317) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_REMOTE_TASKFILES=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -This experiment allows you to specify a remote Taskfile URL when including a Taskfile. For example: - -```yaml -version: '3' - -includes: - my-remote-namespace: https://raw.githubusercontent.com/my-org/my-repo/main/Taskfile.yml -``` - -This works exactly the same way that including a local file does. Any tasks in the remote Taskfile will be available to run from your main Taskfile via the namespace `my-remote-namespace`. For example, if the remote file contains the following: - -```yaml -version: '3' - -tasks: - hello: - silent: true - cmds: - - echo "Hello from the remote Taskfile!" -``` - -and you run `task my-remote-namespace:hello`, it will print the text: "Hello from the remote Taskfile!" to your console. - -## Security - -Running commands from sources that you do not control is always a potential security risk. For this reason, we have added some checks when using remote Taskfiles: - -1. When running a task from a remote Taskfile for the first time, Task will print a warning to the console asking you to check that you are sure that you trust the source of the Taskfile. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the remote Taskfile will run and further calls to the remote Taskfile will not prompt you again. -2. Whenever you run a remote Taskfile, Task will create and store a checksum of the file that you are running. If the checksum changes, then Task will print another warning to the console to inform you that the contents of the remote file has changed. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the checksum will be updated and the remote Taskfile will run. - -Sometimes you need to run Task in an environment that does not have an interactive terminal, so you are not able to accept a prompt. In these cases you are able to tell task to accept these prompts automatically by using the `--yes` flag. Before enabling this flag, you should: - -1. Be sure that you trust the source and contents of the remote Taskfile. -2. Consider using a pinned version of the remote Taskfile (e.g. A link containing a commit hash) to prevent Task from automatically accepting a prompt that says a remote Taskfile has changed. - -Task currently supports both `http` and `https` URLs. However, the `http` requests will not execute by default unless you run the task with the `--insecure` flag. This is to protect you from accidentally running a remote Taskfile that is hosted on and unencrypted connection. Sources that are not protected by TLS are vulnerable to [man-in-the-middle attacks][man-in-the-middle-attacks] and should be avoided unless you know what you are doing. - -## Caching & Running Offline - -Whenever you run a remote Taskfile, the latest copy will be downloaded from the internet and cached locally. If for whatever reason, you lose access to the internet, you will still be able to run your tasks by specifying the `--offline` flag. This will tell Task to use the latest cached version of the file instead of trying to download it. You are able to use the `--download` flag to update the cached version of the remote files without running any tasks. - -By default, Task will timeout requests to download remote files after 10 seconds and look for a cached copy instead. This timeout can be configured by setting the `--timeout` flag and specifying a duration. For example, `--timeout 5s` will set the timeout to 5 seconds. - - - - -[enabling-experiments]: /experiments/#enabling-experiments -[man-in-the-middle-attacks]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/template.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/template.md deleted file mode 100644 index 59246cf5..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/template.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Experiment\} (#\{Issue\}) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- \{list any existing functionality that will be broken by this experiment\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_{feature}=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -\{Short description of the feature\} - -\{Short explanation of how users should migrate to the new behavior\} - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/workflow.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/workflow.md deleted file mode 100644 index 62aff616..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/experiments/workflow.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /experiments/workflow/ ---- - -# Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -## 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -## 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -## 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -## 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -## 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -## Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/faq.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/faq.md deleted file mode 100644 index 66acce49..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/faq.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -slug: /faq/ -sidebar_position: 15 ---- - -# FAQ - -このページはTaskに関するよくある質問についてまとめたものです。 - -## タスクがシェル環境を更新しないのはなぜですか？ - -これはシェルの仕組みの制限です。 Taskは現在のシェルのサブプロセスとして実行されるため、それを起動したシェルの環境を変更することができません。 この制限は他のタスクランナーやビルドツールでも同様です。 - -これを回避する一般的な方法は、シェルが解析できる出力を生成するタスクを作成することです。 例えば、シェルの環境変数を設定するには以下のようなタスクを書くことができます: - -```yaml -my-shell-env: - cmds: - - echo "export FOO=foo" - - echo "export BAR=bar" -``` - -そして、`eval $(task my-shell-env)`を実行することで、変数`$FOO`と`$BAR`がシェルで使用可能になります。 - -## タスクのコマンドでシェルを再利用できません - -Taskはそれぞれのコマンドを異なるシェルプロセスとして実行するため、一つのコマンドが他のコマンドには影響されることはありません。 例えば、以下は上手く動きません: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - a=foo - - echo $a - # outputs "" -``` - -これを上手く動かすためには複数行コマンドを利用します: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - | - a=foo - echo $a - # outputs "foo" -``` - -もっと複雑なコマンドの場合は、ファイルを用意してそれを呼び出すようにすることを推奨します: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - ./foo-printer.bash -``` - -```bash -#!/bin/bash -a=foo -echo $a -``` - -## 'x'組み込みコマンドがWindowsで動作しません - -Windowsのデフォルトシェル(`cmd`と`powershell`)は、組み込みシェルとして`rm`や`cp`がありません。 つまり、これらのコマンドは動作しません。 Taskfileをクロスプラットフォームにしたい場合は、次のいずれかの方法で制限を回避する必要があります: - -- `{{OS}}`関数を使用して、OS固有のスクリプトを実行する。 -- `{{if eq OS "windows"}}powershell {{end}}`のようにWindowsかを判別して、Powershellを実行する。 -- Windowsでこれらのコマンドを組み込みでサポートするシェルを使ってください。例えば[Git Bash][git-bash]または[WSL][wsl]などがあります。 - -私たちはTaskのこの部分に改善したいと思っており、以下のIssueがそれを追跡するものです。 建設的なコメントやコントリビュートは大歓迎です！ - -- #197 -- [mvdan/sh#93](https://github.com/mvdan/sh/issues/93) -- [mvdan/sh#97](https://github.com/mvdan/sh/issues/97) - - - - -[git-bash]: https://gitforwindows.org/ -[wsl]: https://learn.microsoft.com/en-us/windows/wsl/install diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/installation.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/installation.md deleted file mode 100644 index 12722f47..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/installation.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -slug: /installation/ -sidebar_position: 2 ---- - -# インストール方法 - -Taskは多くのインストール方法を提供します。 以下にある利用可能な方法を確認してください。 - -## パッケージマネージャー - -### Homebrew - -macOSやLinuxを使っていて、[Homebrew][homebrew]をインストールしている場合は、以下を実行することで簡単にTaskをインストールできます: - -```bash -brew install go-task/tap/go-task -``` - -上記のFormulaは、[私たちによってメンテナンスされています](https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb)。 - -最近、Taskは[公式のHomebrewリポジトリ](https://formulae.brew.sh/formula/go-task)でも利用可能になったので、以下の方法でもインストールできます: - -```bash -brew install go-task -``` - -### Tea - -macOSやLinuxを使っていて、[tea][tea]をインストールしている場合は、以下を実行することで簡単にTaskをインストールできます: - -```bash -tea task -``` - -teaの魔法が有効になっている場合: - -```bash -task -``` -このインストール方法はコミュニティが所有しています。 Taskの新しいリリースが出来た後、自動的にteaが最小限の時間でリリースします。 - -### Snap - -Taskは[ Snapcraft][snapcraft]で提供されていますが、Snapを適切に動作させるためには、あなたのLinux distributionがクラシックな制限を許可することを念頭に置いておいてください: - -```bash -sudo snap install task --classic -``` - -### Chocolatey - -Windowsを使っていて、[Chocolatey][choco]をインストールしていれば、以下を実行することで簡単にTaskをインストールできます: - -```bash -choco install go-task -``` - -このインストール方法はコミュニティーが所有しています。 - -### Scoop - -Windowsを使っていて、[Scoop][scoop]をインストールしていれば、以下を実行することで簡単にTaskをインストールできます: - -```cmd -scoop install task -``` - -このインストール方法はコミュニティーが所有しています。 Taskの新しいリリースが出来た後、Scoopで利用可能になるには時間がかかるかもしれません。 - -### AUR - -Arch Linuxを使っていれば、あなたの好きなパッケージマネージャ(`yay`、`pacaur`、または`yaourt`など)を使って[AUR](https://aur.archlinux.org/packages/go-task-bin)からTaskをインストールできます: - -```cmd -yay -S go-task-bin -``` - -あるいは、[リリースページ](https://github.com/go-task/task/releases)からバイナリをダウンロードする代わりに、ソースコードからインストールする[パッケージ](https://aur.archlinux.org/packages/go-task)もあります： - -```cmd -yay -S go-task -``` - -このインストール方法はコミュニティーが所有しています。 - -### Fedora - -Fedora Linuxを使っている場合、`dnf`を使って、公式の[Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/)リポジトリからTaskをインストールできます: - -```cmd -sudo dnf install go-task -``` - -このインストール方法はコミュニティーが所有しています。 Taskの新しいリリースが出来た後、[Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/)で利用可能になるには時間がかかるかもしれません。 - -### Nix - -NixOSを使っている場合、またはNixをインストールしている場合、[nixpkgs](https://github.com/NixOS/nixpkgs)からTaskをインストールできます。 - -```cmd -nix-env -iA nixpkgs.go-task -``` - -このインストール方法はコミュニティーが所有しています。 Taskの新しいリリースが出来た後、[nixpkgs](https://github.com/NixOS/nixpkgs)で利用可能になるには時間がかかるかもしれません。 - -### npm - -Nodeとnpmを使って[このパッケージ](https://www.npmjs.com/package/@go-task/cli)をインストールすることでTaskをインストールすることもできます。 - -```bash -npm install -g @go-task/cli -``` - -### Winget - -Windowsを使っていて、[winget](https://github.com/microsoft/winget-cli)パッケージマネジメントツールをインストールしていれば、[winget-pkgs](https://github.com/microsoft/winget-pkgs)からTaskをインストールできます。 - -```bash -winget install Task.Task -``` - -## バイナリの取得 - -### バイナリ - -[GitHubのリリースページ][releases]からバイナリをダウンロードして`$PATH`に追加することでインストールできます。 - -DEBとRPMパッケージも利用可能です。 - -`task_checksums.txt`ファイルには、各バイナリファイルのSHA-256チェックサムが記載されています。 - -### スクリプトを使ったインストール - -[install script][installscript]もあり、CIのような場面で非常に有用です。 [GoDownloader][godownloader]のおかげで、スクリプトを簡単に生成することができました。 - -デフォルトでは作業ディレクトリに相対的な`./bin`ディレクトリにインストールされます: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -``` - -`-b`パラメータでインストールディレクトリを上書きすることができます。 Linuxでは、現在のユーザー向けには`~/.local/bin`や`~/bin`、すべてのユーザー向けには`/usr/local/bin`をインストール先として選択することが一般的です: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin -``` - -:::caution - -macOSとWindowsでは`~/.local/bin`と`~/bin`は、`$PATH`にデフォルトで追加されていません。 - -::: - -### GitHub Actions - -GitHub ActionsでTaskをインストールしたい場合、Arduinoチームの[action](https://github.com/arduino/setup-task)を使用してみてください: - -```yaml -- name: Install Task - uses: arduino/setup-task@v1 - with: - version: 3.x - repo-token: ${{ secrets.GITHUB_TOKEN }} -``` - -このインストール方法はコミュニティーが所有しています。 - -## ソースコードからビルド - -### Goモジュール - -[Go][go]のサポート対象のバージョンが適切にインストールおよびセットアップされていることを確認してください。 Goの必要な最小バージョンは[go.mod](https://github.com/go-task/task/blob/main/go.mod#L3)ファイルから確認できます。 - -以下を実行することで最新のリリースをグローバルにインストールできます: - -```bash -go install github.com/go-task/task/v3/cmd/task@latest -``` - -別のディレクトリにインストールすることもできます: - -```bash -env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest -``` - -:::tip - -CI環境では、最新リリースのバイナリを早く、安定して提供する[install script](#install-script)を使うことをおすすめします。 - -::: - -## 補完のセットアップ - -使用しているシェルに対応した自動補完ファイルをダウンロードしてください。 - -[シェルに対応した自動補完ファイルはTaskリポジトリにあります](https://github.com/go-task/task/tree/main/completion)。 - -### Bash - -まず、パッケージマネージャを使用してbash-completionがインストールされていることを確認します。 - -補完ファイルを実行可能にします: - -``` -chmod +x path/to/task.bash -``` - -その後、以下の行を`~/.bash_profile`に追加してください: - -```shell -source path/to/task.bash -``` - -### ZSH - -`_task`ファイルを`$FPATH`のどこかに置きます: - -```shell -mv path/to/_task /usr/local/share/zsh/site-functions/_task -``` - -`~/.zshrc`に以下の内容が含まれていることを確認してください: - -```shell -autoload -U compinit -compinit -i -``` - -ZSHバージョンは5.7以降をおすすめします。 - -### Fish - -` task.fish`補完スクリプトを移動させます: - -```shell -mv path/to/task.fish ~/.config/fish/completions/task.fish -``` - -### PowerShell - -プロファイルスクリプトを開きます: - -``` -mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue -notepad $profile -``` - -以下の行を追加してファイルを保存します: - -```shell -Invoke-Expression -Command path/to/task.ps1 -``` - - - - -[go]: https://golang.org/ -[snapcraft]: https://snapcraft.io/task -[homebrew]: https://brew.sh/ -[installscript]: https://github.com/go-task/task/blob/main/install-task.sh -[releases]: https://github.com/go-task/task/releases -[godownloader]: https://github.com/goreleaser/godownloader -[choco]: https://chocolatey.org/ -[scoop]: https://scoop.sh/ -[tea]: https://tea.xyz/ diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/integrations.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/integrations.md deleted file mode 100644 index b6e4c800..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/integrations.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -slug: /integrations/ -sidebar_position: 8 ---- - -# Integrations - -## Visual Studio Code Extension - -Task has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task). The code for this project can be found [here](https://github.com/go-task/vscode-task). To use this extension, you must have Task v3.23.0+ installed on your system. - -This extension provides the following features (and more): - -- View tasks in the sidebar. -- Run tasks from the sidebar and command palette. -- Go to definition from the sidebar and command palette. -- Run last task command. -- Multi-root workspace support. -- Initialize a Taskfile in the current workspace. - -To get autocompletion and validation for your Taskfile, see the [Schema](#schema) section below. - -![Task for Visual Studio Code](https://github.com/go-task/vscode-task/blob/main/res/preview.png?raw=true) - -## Schema - -This was initially created by @KROSF in [this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and is now officially maintained in [this file](https://github.com/go-task/task/blob/main/docs/static/schema.json) and made available at https://taskfile.dev/schema.json. This schema can be used to validate Taskfiles and provide autocompletion in many code editors: - -### Visual Studio Code - -To integrate the schema into VS Code, you need to install the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) by Red Hat. Any `Taskfile.yml` in your project should automatically be detected and validation/autocompletion should work. If this doesn't work or you want to manually configure it for files with a different name, you can add the following to your `settings.json`: - -```json -// settings.json -{ - "yaml.schemas": { - "https://taskfile.dev/schema.json": [ - "**/Taskfile.yml", - "./path/to/any/other/taskfile.yml" - ] - } -} -``` - -You can also configure the schema directly inside of a Taskfile by adding the following comment to the top of the file: - -```yaml -# yaml-language-server: $schema=https://taskfile.dev/schema.json -version: '3' -``` - -You can find more information on this in the [YAML language server project](https://github.com/redhat-developer/yaml-language-server). - -## Community Integrations - -In addition to our official integrations, there is an amazing community of developers who have created their own integrations for Task: - -- [Sublime Text Plugin](https://packagecontrol.io/packages/Taskfile) [[source](https://github.com/biozz/sublime-taskfile)] by @biozz -- [IntelliJ Plugin](https://plugins.jetbrains.com/plugin/17058-taskfile) [[source](https://github.com/lechuckroh/task-intellij-plugin)] by @lechuckroh -- [mk](https://github.com/pycontribs/mk) command line tool recognizes Taskfiles natively. - -If you have made something that integrates with Task, please feel free to open a PR to add it to this list. diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/intro.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/intro.md deleted file mode 100644 index f3b8214f..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/intro.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -slug: / -sidebar_position: 1 -title: ホーム ---- - -# Task - -
- -
- -Taskは[GNU Make][make]のようにシンプルで簡単に使えるタスクランナー・ビルドツールです。 - -[Go][go]で書かれているため、Taskはシングルバイナリで他の依存関係がありません。つまり、複雑なインストールセットアップがありません。 - -Once [installed](/installation), you just need to describe your build tasks using a simple [YAML][yaml] schema in a file called `Taskfile.yml`: - -```yaml title="Taskfile.yml" -version: '3' - -tasks: - hello: - cmds: - - echo 'Hello World from Task!' - silent: true -``` - -記述後はターミナル上で`task hello`と実行することでそのタスクが実行されます。 - -上記の例は始まりに過ぎません。 全てのスキーマやTaskの機能については、[usage](/usage)ガイドを確認するといいでしょう。 - -## 特徴 - -- [Easy installation](/installation): just download a single binary, add to `$PATH` and you're done! または[Homebrew][homebrew]、[Snapcraft][snapcraft]、[Scoop][scoop]を使ってインストールすることができます。 -- Available on CIs: by adding [this simple command](/installation#install-script) to install on your CI script and you're ready to use Task as part of your CI pipeline; -- 真のクロスプラットフォーム: ほとんどのビルドツールはLinuxまたはmacOSだけで使用可能ですが、Taskは[Goのシェルインタープリタ][sh]を使うことでWindowsもサポートしています。 -- コード生成に適している: 特定のファイル群が最後に実行されてから変更されていない場合(タイムスタンプや内容に基づき)、簡単に[タスクの実行を防ぐ](/usage#prevent-unnecessary-work)ことができます。 - - - - -[make]: https://www.gnu.org/software/make/ -[go]: https://go.dev/ -[yaml]: http://yaml.org/ -[homebrew]: https://brew.sh/ -[snapcraft]: https://snapcraft.io/ -[scoop]: https://scoop.sh/ -[sh]: https://github.com/mvdan/sh diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/releasing.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/releasing.md deleted file mode 100644 index 261469b1..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/releasing.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /releasing/ -sidebar_position: 13 ---- - -# リリース - -Taskのリリースプロセスは[GoReleaser][goreleaser]の助けを借りて行われます。 ローカルでリリースプロセスをテストするには、Taskfileの`test-release`タスクを呼び出します。 - -[GitHub Actions](https://github.com/go-task/task/actions)は、新しいGitタグが`main`ブランチにプッシュされると、自動的に成果物(実行ファイルおよびDEBとRPMパッケージ)をリリースするはずです。 - -v3.15.0以降、特定のタグをチェックアウトし、上記のGitHub Actionsで定義されたGoバージョンを使用して`goreleaser build`を呼び出すことで、実行ファイルをローカルでも再現して検証することができます。 - -# Homebrew - -Goreleaser will automatically push a new commit to the [Formula/go-task.rb][gotaskrb] file in the [Homebrew tap][homebrewtap] repository to release the new version. - -# npm - -npmにリリースするには、[`package.json`][packagejson]でバージョンを更新し、`task npm:publish`を実行してプッシュします。 - -# Snapcraft - -[snapパッケージ][snappackage]をリリースするには、マニュアルのステップが必要です: - -- Updating the current version on [snapcraft.yaml][snapcraftyaml]. -- [Snapcraftダッシュボード][snapcraftdashboard]で、`amd64`、`armhf`、`arm64`の新しい成果物を全てstableチャンネルに移動させる。 - -# winget - -wingetもマニュアルのステップが必要です。 By running `task goreleaser:test` locally, manifest files will be generated on `dist/winget/manifests/t/Task/Task/v{version}`. [マニフェストディレクトリをこのフォーク](https://github.com/go-task/winget-pkgs/tree/master/manifests/t/Task/Task)にアップロードし、[このリポジトリ](https://github.com/microsoft/winget-pkgs)にプルリクエストを作ってください。 - -# Scoop - -ScoopはWindowsオペレーティングシステム用のコマンドラインパッケージマネージャーです。 Scoopパッケージマニフェストはコミュニティによって管理されています。 Scoopの所有者は通常、[このファイル](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json)を編集することでバージョンを更新します。 Taskのバージョンが古くなっていると思われる場合は、Issueを作成してお知らせください。 - -# Nix - -Nixはコミュニティが所有するインストール方法です。 Nixパッケージのメンテナは通常、[このファイル](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/development/tools/go-task/default.nix)を編集してバージョンを更新します。 Taskのバージョンが古くなっていると思われる場合は、Issueを作成してお知らせください。 - - - - -[goreleaser]: https://goreleaser.com/ -[homebrewtap]: https://github.com/go-task/homebrew-tap -[gotaskrb]: https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb -[packagejson]: https://github.com/go-task/task/blob/main/package.json#L3 -[snappackage]: https://github.com/go-task/snap -[snapcraftyaml]: https://github.com/go-task/snap/blob/main/snap/snapcraft.yaml#L2 -[snapcraftdashboard]: https://snapcraft.io/task/releases diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/styleguide.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/styleguide.md deleted file mode 100644 index 3a19a11a..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/styleguide.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -slug: /styleguide/ -sidebar_position: 10 ---- - -# スタイルガイド - -これは`Taskfile.yml`の公式Taskスタイルガイドです。 このガイドには、Taskfileを整理し、他ユーザーにとっても理解しやすいように保つための基本的な手順が含まれています。 - -これには一般的なガイドラインが含まれていますが、必ずしも厳密に従う必要はありません。 必要であったり、あるいは違う方法を取りたい場合は自由にしてください。 また、このガイドの改善点について、IssueまたはPull Requestを開くことも自由です。 - -## キーワードを正しい順序にする - -- `version:` -- `includes:` -- 設定項目として、`output:`、`silent:`、`method:`、そして`run:`があります。 -- `vars:` -- `env:`, `dotenv:` -- `tasks:` - -## インデントにはスペース2つを使用する - -これはYAMLファイルの最も一般的な慣習であり、Taskはそれに倣うものです。 - -```yaml -# bad -tasks: - foo: - cmds: - - echo 'foo' - - -# good -tasks: - foo: - cmds: - - echo 'foo' -``` - -## メインセクションをスペースで分ける - -```yaml -# bad -version: '3' -includes: - docker: ./docker/Taskfile.yml -output: prefixed -vars: - FOO: bar -env: - BAR: baz -tasks: - # ... - - -# good -version: '3' - -includes: - docker: ./docker/Taskfile.yml - -output: prefixed - -vars: - FOO: bar - -env: - BAR: baz - -tasks: - # ... -``` - -## タスク間にスペースを設ける - -```yaml -# bad -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - bar: - cmds: - - echo 'bar' - baz: - cmds: - - echo 'baz' - - -# good -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - - bar: - cmds: - - echo 'bar' - - baz: - cmds: - - echo 'baz' -``` - -## 変数名は大文字で定義する - -```yaml -# bad -version: '3' - -vars: - binary_name: myapp - -tasks: - build: - cmds: - - go build -o {{.binary_name}} . - - -# good -version: '3' - -vars: - BINARY_NAME: myapp - -tasks: - build: - cmds: - - go build -o {{.BINARY_NAME}} . -``` - -## テンプレート記法で変数名の前後に空白を設けない - -```yaml -# bad -version: '3' - -tasks: - greet: - cmds: - - echo '{{ .MESSAGE }}' - - -# good -version: '3' - -tasks: - greet: - cmds: - - echo '{{.MESSAGE}}' -``` - -この書き方は多くの人によってGoのテンプレート作成にも使われています。 - -## タスク名の単語をハイフンで区切る - -```yaml -# bad -version: '3' - -tasks: - do_something_fancy: - cmds: - - echo 'Do something' - - -# good -version: '3' - -tasks: - do-something-fancy: - cmds: - - echo 'Do something' -``` - -## タスクの名前空間にコロンを使用する - -```yaml -# good -version: '3' - -tasks: - docker:build: - cmds: - - docker ... - - docker:run: - cmds: - - docker-compose ... -``` - -これはインクルードされたタスクファイルを使用する場合に、自動的に行われます。 - -## 複雑な複数行のコマンドの使用は避け、外部スクリプトを使用する - -```yaml -# bad -version: '3' - -tasks: - build: - cmds: - - | - for i in $(seq 1 10); do - echo $i - echo "some other complex logic" - done' - -# good -version: '3' - -tasks: - build: - cmds: - - ./scripts/my_complex_script.sh -``` diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/taskfile_versions.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/taskfile_versions.md deleted file mode 100644 index 462e856b..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/taskfile_versions.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -slug: /taskfile-versions/ -sidebar_position: 5 ---- - -# Taskfileバージョン - -The Taskfile syntax and features changed with time. This document explains what changed on each version and how to upgrade your Taskfile. - -## What the Taskfile version mean - -The Taskfile version follows the Task version. E.g. the change to Taskfile version `2` means that Task `v2.0.0` should be release to support it. - -The `version:` key on Taskfile accepts a semver string, so either `2`, `2.0` or `2.0.0` is accepted. If you choose to use `2.0` Task will not enable future `2.1` features, but if you choose to use `2`, then any `2.x.x` features will be available, but not `3.0.0+`. - -## Version 3 ![latest](https://img.shields.io/badge/latest-brightgreen) - -These are some major changes done on `v3`: - -- Task's output will now be colored -- Added support for `.env` like files -- Added `label:` setting to task so one can override how the task name appear in the logs -- A global `method:` was added to allow setting the default method, and Task's default changed to `checksum` -- Two magic variables were added when using `status:`: `CHECKSUM` and `TIMESTAMP` which contains, respectively, the XXH3 checksum and greatest modification timestamp of the files listed on `sources:` -- Also, the `TASK` variable is always available with the current task name -- CLI variables are always treated as global variables -- Added `dir:` option to `includes` to allow choosing on which directory an included Taskfile will run: - -```yaml -includes: - docs: - taskfile: ./docs - dir: ./docs -``` - -- Implemented short task syntax. All below syntaxes are equivalent: - -```yaml -version: '3' - -tasks: - print: - cmds: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: echo "Hello, World!" -``` - -- There was a major refactor on how variables are handled. They're now easier to understand. The `expansions:` setting was removed as it became unnecessary. This is the order in which Task will process variables, each level can see the variables set by the previous one and override those. - - Environment variables - - Global + CLI variables - - Call variables - - Task variables - -## Version 2.6 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.6 comes with `preconditions` stanza in tasks. - -```yaml -version: '2' - -tasks: - upload_environment: - preconditions: - - test -f .env - cmds: - - aws s3 cp .env s3://myenvironment -``` - -Please check the [documentation][includes] - -## Version 2.2 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.2 comes with a global `includes` options to include other Taskfiles: - -```yaml -version: '2' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -## Version 2.1 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.1 includes a global `output` option, to allow having more control over how commands output are printed to the console (see [documentation][output] for more info): - -```yaml -version: '2' - -output: prefixed - -tasks: - server: - cmds: - - go run main.go - prefix: server -``` - -From this version it's also possible to ignore errors of a command or task (check documentation [here][ignore_errors]): - -```yaml -version: '2' - -tasks: - example-1: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "This will be print" - - example-2: - cmds: - - exit 1 - - echo "This will be print" - ignore_error: true -``` - -## Version 2.0 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -At version 2, we introduced the `version:` key, to allow us to evolve Task with new features without breaking existing Taskfiles. The new syntax is as follows: - -```yaml -version: '2' - -tasks: - echo: - cmds: - - echo "Hello, World!" -``` - -Version 2 allows you to write global variables directly in the Taskfile, if you don't want to create a `Taskvars.yml`: - -```yaml -version: '2' - -vars: - GREETING: Hello, World! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -The variable priority order changed to the following: - -1. Task variables -2. Call variables -3. Taskfile variables -4. Taskvars file variables -5. Environment variables - -A new global option was added to configure the number of variables expansions (which default to 2): - -```yaml -version: '2' - -expansions: 3 - -vars: - FOO: foo - BAR: bar - BAZ: baz - FOOBAR: '{{.FOO}}{{.BAR}}' - FOOBARBAZ: '{{.FOOBAR}}{{.BAZ}}' - -tasks: - default: - cmds: - - echo "{{.FOOBARBAZ}}" -``` - -## Version 1 - -:::caution - -v1 schema support was removed in Task >= v3.0.0. - -::: - -In the first version of the `Taskfile`, the `version:` key was not available, because the tasks was in the root of the YAML document. Like this: - -```yaml -echo: - cmds: - - echo "Hello, World!" -``` - -The variable priority order was also different: - -1. Call variables -2. Environment -3. Task variables -4. `Taskvars.yml` variables - - - - -[deprecate-version-2-schema]: /deprecations/version-2-schema/ -[output]: /usage#output-syntax -[ignore_errors]: /usage#ignore-errors -[includes]: /usage#including-other-taskfiles diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/translate.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/translate.md deleted file mode 100644 index f523b623..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/translate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -slug: /translate/ -sidebar_position: 12 ---- - -# 翻訳 - -このドキュメントの翻訳を手伝ってくれませんか？ このドキュメントではどのように翻訳に協力できるかを説明します。 - -※GitHubリポジトリ上にある翻訳されたマークダウンファイルを直接編集しないでください！ 翻訳作業は[Crowdin][crowdin]を使っています。 リポジトリはCrowdinからの進捗状況で定期的に更新されます。 - -翻訳に協力するためにCrowdinプロジェクトへのアクセスが必要な場合は、[Discordサーバーの#translationsチャンネル][discord]でCrowdinへのアクセスを依頼してください。 特定の言語がまだCrowdinに表示されていない場合は依頼してください。 - - - - -[crowdin]: https://crowdin.com/project/taskfile -[discord]: https://discord.gg/6TY36E39UK diff --git a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/usage.md b/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/usage.md deleted file mode 100644 index 02271b5d..00000000 --- a/docs/i18n/ja-JP/docusaurus-plugin-content-docs/current/usage.md +++ /dev/null @@ -1,1624 +0,0 @@ ---- -slug: /usage/ -sidebar_position: 3 ---- - -# 使い方 - -## はじめに - -プロジェクトのルートに`Taskfile.yml`というファイルを作成します。 `cmds`属性にはタスクのコマンドを記載する必要があります。 以下の例はGoアプリをコンパイルするタスクと、[esbuild](https://esbuild.github.io/)を使って複数のCSSファイルを結合・小さくして1つのファイルにするタスクがあります。 - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -タスクは以下のように簡単に実行できます: - -```bash -task assets build -``` - -Taskは[mvdan.cc/sh](https://mvdan.cc/sh/)というネイティブなGo shインタプリタを使用しています。 なのでsh/bashコマンドを書いても、Windowsのような`sh`や`bash`が無いような環境でも動かすことが可能です。 実行可能なファイルはOSからアクセスできる場所、もしくはPATH内にある必要があることを覚えておいてください。 - -タスク名を省略すると、"default"が実行されます。 - -## サポートされているファイル名 - -Taskは以下のような優先順位でファイルを探します: - -- Taskfile.yml -- taskfile.yml -- Taskfile.yaml -- taskfile.yaml -- Taskfile.dist.yml -- taskfile.dist.yml -- Taskfile.dist.yaml -- taskfile.dist.yaml - -`.dist`が存在する意図は、プロジェクトが1つの固定されたバージョン(`.dist`)を持つ一方で、個々のユーザーが`Taskfile.yml`を追加することでTaskfileを上書きできるようにすることです(個々が追加したTaskfileは`.gitignore`に追加されている) - -### サブディレクトリからTaskfileを実行する - -カレントワーキングディレクトリからTaskfileが見つからなかったときは、見つかるまでファイルツリーを走査します(`git`の動きに似ています)。 このようにタスクをサブディレクトリで実行すると、Taskfileがあるディレクトリから実行したかのように動きます。 - -このような機能を特別な`{{.USER_WORKING_DIR}}`変数を使うことで、非常に便利で再利用可能なタスクを作成できます。 例えば、各マイクロサービスごとのディレクトリがあるモノリポがある場合、同じ内容の複数のタスクやTaskfileを作らずに、マイクロサービスのディレクトリに`cd`で移動し、タスクコマンドを実行することができます。 例: - -```yaml -version: '3' - -tasks: - up: - dir: '{{.USER_WORKING_DIR}}' - preconditions: - - test -f docker-compose.yml - cmds: - - docker-compose up -d -``` - -上記の例では、`cd `と`task up`を実行すると、``ディレクトリに`docker-copmose.yml`があれば、Docker compositionが立ち上がります。 - -### グローバルなTaskfileを実行する - -`--global` (エイリアス `-g`) フラグと一緒にTaskを実行すると、ワーキングディレクトリの代わりにホームディレクトリからTaskfileを探します。 つまり、Taskは`$HOME/{T,t}askfile.{yml,yaml}`にマッチするファイルを探します。 - -これはシステム内のどこからでも自動化処理を実行可能にする便利な機能です！ - -:::info - -グローバルなTaskfileを`-g`で実行するとき、タスクはワーキンクディレクトリではなく、デフォルトでは`$HOME`ディレクトリで実行されます！ - -前述したように、`{{.USER_WORKING_DIR}}`という特別な変数は非常に便利で、`task -g`を呼び出しているディレクトリで実行させることができます。 - -```yaml -version: '3' - -tasks: - from-home: - cmds: - - pwd - - from-working-directory: - dir: '{{.USER_WORKING_DIR}}' - cmds: - - pwd -``` - -::: - -## 環境変数 - -### タスク - -`env`を使用して特定のタスクにカスタム環境変数を設定できます: - -```yaml -version: '3' - -tasks: - greet: - cmds: - - echo $GREETING - env: - GREETING: Hey, there! -``` - -また、すべてのタスクに適用できるグローバルな環境変数を設定することもできます: - -```yaml -version: '3' - -env: - GREETING: Hey, there! - -tasks: - greet: - cmds: - - echo $GREETING -``` - -:::info - -`env`は変数と同様に、シェルコマンドからの出力を取得して展開することが可能です。詳細は[変数](#variables)セクションを参照してください。 - -::: - -### .envファイル - -`dotenv:`設定を使用してTaskに`.env`のようなファイルを読み込ませることもできます: - -```bash title=".env" -KEYNAME=VALUE -``` - -```bash title="testing/.env" -ENDPOINT=testing.com -``` - -```yaml title="Taskfile.yml" -version: '3' - -env: - ENV: testing - -dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - -tasks: - greet: - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -dotenvファイルはタスクレベルでも使用可能です: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -タスクレベルで明示的に定義された環境変数は、dotenvで読み込んだ変数を上書きします: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - env: - KEYNAME: DIFFERENT_VALUE - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -:::info - -インクルードされたTaskfile内では、`dotenv`設定が現在は使えないことに注意してください。 - -::: - -## 他のTaskfileをインクルードする - -異なるプロジェクト(Taskfile)間でタスクを共有したい場合、`includes`キーワードを利用して他のTaskfileをインクルードするためのインポートメカニズムを利用できます。 - -```yaml -version: '3' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -指定されたTaskfileに記述されたタスクは、指定された名前空間で利用できるようになります。 なので、`documentation/Taskfile.yml`から`serve`タスクを実行するには、`task docs:serve`を呼び、`DockerTasks.yml`から`build`タスクを実行するには、`task docker:build`を呼び出します。 - -相対パスはインクルードするTaskfileが含まれているディレクトリに対して解決されます。 - -### OS固有のTaskfile - -`version: '2'`では、taskは`Taskfile_{{OS}}.yml`が存在する場合、自動的にインクルードします。(例えば: `Taskfile_windows.yml`、`Taskfile_linux.yml`、`Taskfile_darwin.yml`など) この挙動は少し分かりづらかったため、バージョン3で削除されましたが、これらのファイルを明示的にインポートすることで同様の挙動を持たせることができます。 - -```yaml -version: '3' - -includes: - build: ./Taskfile_{{OS}}.yml -``` - -### インクルードされたTaskfileのディレクトリ - -デフォルトでは、インクルードされたTaskfileのタスクは、Taskfileが別のディレクトリにあったとしても、現在のディレクトリで実行されます。 ですが、代替構文を利用することで、強制的にタスクを別のディレクトリで実行させることができます: - -```yaml -version: '3' - -includes: - docs: - taskfile: ./docs/Taskfile.yml - dir: ./docs -``` - -:::info - -インクルードされるTaskfileは、メインのTaskfileが使用しているスキーマバージョンと同様のものである必要があります。 - -::: - -### 任意のインクルード - -オプショナルとしてマークされたインクルードは、インクルードされるファイルが見つからない場合でも、タスクの実行を通常通り続行させます。 - -```yaml -version: '3' - -includes: - tests: - taskfile: ./tests/Taskfile.yml - optional: true - -tasks: - greet: - cmds: - - echo "This command can still be successfully executed if - ./tests/Taskfile.yml does not exist" -``` - -### 内部のインクルード - -インターナルとしてマークされたインクルードは、インクルードされるファイルの全てのタスクもインターナルとします(下記の [インターナルタスク](#internal-tasks)セクションを参照)。 これはユーザーが直接使用することを意図していないユーティリティタスクをインクルードする際に便利です。 - -```yaml -version: '3' - -includes: - tests: - taskfile: ./taskfiles/Utils.yml - internal: true -``` - -### インクルードされるTaskfileの変数 - -Taskfileをインクルードする際に変数を使用することもできます。 これは一度に複数回インクルードするような再利用可能なTaskfileを持つのに便利です。 - -```yaml -version: '3' - -includes: - backend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: backend_image - - frontend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: frontend_image -``` - -### ネームスペースのエイリアス - -Taskfileをインクルードする際は、ネームスペースに`エイリアス`のリストを渡すことができます。 これは[タスクエイリアス](#task-aliases)と同じように機能し、短くてタイプしやすいコマンドを使用するために一緒に使うことができます。 - -```yaml -version: '3' - -includes: - generate: - taskfile: ./taskfiles/Generate.yml - aliases: [gen] -``` - -:::info - -インクルードされたTaskfileで宣言された変数は、インクルードしているTaskfile内の変数よりも優先されます！ インクルードされたTaskfileの変数を上書き可能にしたい場合は、[default関数](https://go-task.github.io/slim-sprig/defaults.html)を使用してください: `MY_VAR: '{{.MY_VAR | default "my-default-value"}}'`。 - -::: - -## インターナルタスク - -内部タスクはユーザーが直接呼び出すことができないタスクです。 `task --list|--list-all`を実行したときの出力に表示されません。 他のタスクは通常通り内部タスクを呼び出すことができます。 これはコマンドライン上で明確な用途を持たないが、再利用可能で関数のようなタスクを作成するのに便利です。 - -```yaml -version: '3' - -tasks: - build-image-1: - cmds: - - task: build-image - vars: - DOCKER_IMAGE: image-1 - - build-image: - internal: true - cmds: - - docker build -t {{.DOCKER_IMAGE}} . -``` - -## タスクディレクトリ - -デフォルトでは、タスクはTaskfileが配置されているディレクトリで実行されます。 ですが、`dir:`を指定することでタスクを簡単に別のディレクトリで実行させることができます。 - -```yaml -version: '3' - -tasks: - serve: - dir: public/www - cmds: - # run http server - - caddy -``` - -ディレクトリが存在しない場合、`task`が作成します。 - -## タスクの依存関係 - -> 依存関係は並列して実行されるため、実行されるタスクの依存関係が互いに依存しないようにする必要があります。 もしタスクを逐次実行するようにしたい場合は、下記の[別のタスクを呼び出す](#calling-another-task)セクションを参照してください。 - -他のタスクに依存するタスクがあるかもしれません。 `deps`にそれらを指定することで、親タスクを実行する前に自動で実行されるようになります。 - -```yaml -version: '3' - -tasks: - build: - deps: [assets] - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -上記の例では、`task build`を実行すると、`assets`は常に`build`前に実行されます。 - -タスクは、自身のコマンドを持たずに、グループ化するためだけの依存関係のみを持たせることができます。 - -```yaml -version: '3' - -tasks: - assets: - deps: [js, css] - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -依存関係が複数ある場合、常に並列で実行されることでパフォーマンスが向上します。 - -:::tip - -コマンドラインで`--parallel`フラグ(エイリアス `-p`)を使用して、指定されたタスクを並列して実行することができます。 例: `task --parallel js css`。 - -::: - -依存関係に情報を渡したい場合は、[別のタスクを呼び出す](#calling-another-task)のと同じ方法で行うことができます。 - -```yaml -version: '3' - -tasks: - default: - deps: - - task: echo_sth - vars: { TEXT: 'before 1' } - - task: echo_sth - vars: { TEXT: 'before 2' } - silent: true - cmds: - - echo "after" - - echo_sth: - cmds: - - echo {{.TEXT}} -``` - -## プラットフォーム固有のタスクとコマンド - -タスクの実行を明示的なプラットフォームに制限したい場合は、`platforms:`キーを使用することができます。 タスクは特定のOS、アーキテクチャ、またはその両方の組み合わせに制限させることができます。 一致しない場合、タスクまたはコマンドはスキップされ、エラーは発生しません。 - -OSまたはArchとして許可されている値は[ここ](https://github.com/golang/go/blob/master/src/go/build/syslist.go)でGo言語によって定義されている有効な`GOOS`と`GOARCH`の値らです。 - -以下の`build-windows`タスクはWindowsと任意のアーキテクチャで実行されます: - -```yaml -version: '3' - -tasks: - build-windows: - platforms: [windows] - cmds: - - echo 'Running command on Windows' -``` - -以下のように特定のアーキテクチャに制限することもできます: - -```yaml -version: '3' - -tasks: - build-windows-amd64: - platforms: [windows/amd64] - cmds: - - echo 'Running command on Windows (amd64)' -``` - -また、特定のアーキテクチャのみに制限することも可能です: - -```yaml -version: '3' - -tasks: - build-amd64: - platforms: [amd64] - cmds: - - echo 'Running command on amd64' -``` - -複数のプラットフォームは以下のように指定できます: - -```yaml -version: '3' - -tasks: - build: - platforms: [windows/amd64, darwin] - cmds: - - echo 'Running command on Windows (amd64) and macOS' -``` - -それぞれのコマンドも特定のプラットフォームに制限することが可能です: - -```yaml -version: '3' - -tasks: - build: - cmds: - - cmd: echo 'Running command on Windows (amd64) and macOS' - platforms: [windows/amd64, darwin] - - cmd: echo 'Running on all platforms' -``` - -## 別のタスクを呼び出す - -タスクに多くの依存関係がある場合、依存しているものは同時に実行されます。 これによりビルドパイプラインが速くなります。 しかし、状況によっては、他のタスクを順番に呼び出したケースがあるかもしれません。 その場合、以下の構文を使用してください: - -```yaml -version: '3' - -tasks: - main-task: - cmds: - - task: task-to-be-called - - task: another-task - - echo "Both done" - - task-to-be-called: - cmds: - - echo "Task to be called" - - another-task: - cmds: - - echo "Another task" -``` - -`vars`属性で変数をを渡すことができ、`silent`属性で[サイレントモード](#silent-mode)を切り替えることができます: - -```yaml -version: '3' - -tasks: - greet: - vars: - RECIPIENT: '{{default "World" .RECIPIENT}}' - cmds: - - echo "Hello, {{.RECIPIENT}}!" - - greet-pessimistically: - cmds: - - task: greet - vars: { RECIPIENT: 'Cruel World' } - silent: true -``` - -上記の構文は`deps`属性でもサポートされています。 - -:::tip - -[他のTaskfileをインクルードする](#including-other-taskfiles)でルートにあるTaskfileをインクルードしていて、そこに定義されたタスクを呼び出したい場合、以下のように先頭に`:`を付け加えてください。 `task: :task-name`。 - -::: - -## Prevent unnecessary work - -### By fingerprinting locally generated files and their sources - -If a task generates something, you can inform Task the source and generated files, so Task will prevent running them if not necessary. - -```yaml -version: '3' - -tasks: - build: - deps: [js, css] - cmds: - - go build -v -i main.go - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - sources: - - src/js/**/*.js - generates: - - public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css - sources: - - src/css/**/*.css - generates: - - public/bundle.css -``` - -`sources` and `generates` can be files or glob patterns. When given, Task will compare the checksum of the source files to determine if it's necessary to run the task. If not, it will just print a message like `Task "js" is up to date`. - -`exclude:` can also be used to exclude files from fingerprinting. Sources are evaluated in order, so `exclude:` must come after the positive glob it is negating. - -```yaml -version: '3' - -tasks: - css: - sources: - - mysources/**/*.css - - exclude: mysources/ignoreme.css - generates: - - public/bundle.css -``` - -If you prefer these check to be made by the modification timestamp of the files, instead of its checksum (content), just set the `method` property to `timestamp`. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build . - sources: - - ./*.go - generates: - - app{{exeExt}} - method: timestamp -``` - -In situations where you need more flexibility the `status` keyword can be used. You can even combine the two. See the documentation for [status](#using-programmatic-checks-to-indicate-a-task-is-up-to-date) for an example. - -:::info - -By default, task stores checksums on a local `.task` directory in the project's directory. Most of the time, you'll want to have this directory on `.gitignore` (or equivalent) so it isn't committed. (If you have a task for code generation that is committed it may make sense to commit the checksum of that task as well, though). - -If you want these files to be stored in another directory, you can set a `TASK_TEMP_DIR` environment variable in your machine. It can contain a relative path like `tmp/task` that will be interpreted as relative to the project directory, or an absolute or home path like `/tmp/.task` or `~/.task` (subdirectories will be created for each project). - -```bash -export TASK_TEMP_DIR='~/.task' -``` - -::: - -:::info - -Each task has only one checksum stored for its `sources`. If you want to distinguish a task by any of its input variables, you can add those variables as part of the task's label, and it will be considered a different task. - -This is useful if you want to run a task once for each distinct set of inputs until the sources actually change. For example, if the sources depend on the value of a variable, or you if you want the task to rerun if some arguments change even if the source has not. - -::: - -:::tip - -The method `none` skips any validation and always run the task. - -::: - -:::info - -For the `checksum` (default) or `timestamp` method to work, it is only necessary to inform the source files. When the `timestamp` method is used, the last time of the running the task is considered as a generate. - -::: - -### Using programmatic checks to indicate a task is up to date - -Alternatively, you can inform a sequence of tests as `status`. If no error is returned (exit status 0), the task is considered up-to-date: - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - status: - - test -d directory - - test -f directory/file1.txt - - test -f directory/file2.txt -``` - -Normally, you would use `sources` in combination with `generates` - but for tasks that generate remote artifacts (Docker images, deploys, CD releases) the checksum source and timestamps require either access to the artifact or for an out-of-band refresh of the `.checksum` fingerprint file. - -Two special variables `{{.CHECKSUM}}` and `{{.TIMESTAMP}}` are available for interpolation within `status` commands, depending on the method assigned to fingerprint the sources. Only `source` globs are fingerprinted. - -Note that the `{{.TIMESTAMP}}` variable is a "live" Go `time.Time` struct, and can be formatted using any of the methods that `time.Time` responds to. - -See [the Go Time documentation](https://golang.org/pkg/time/) for more information. - -You can use `--force` or `-f` if you want to force a task to run even when up-to-date. - -Also, `task --status [tasks]...` will exit with a non-zero exit code if any of the tasks are not up-to-date. - -`status` can be combined with the [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) to have a task run if either the the source/generated artifacts changes, or the programmatic check fails: - -```yaml -version: '3' - -tasks: - build:prod: - desc: Build for production usage. - cmds: - - composer install - # Run this task if source files changes. - sources: - - composer.json - - composer.lock - generates: - - ./vendor/composer/installed.json - - ./vendor/autoload.php - # But also run the task if the last build was not a production build. - status: - - grep -q '"dev": false' ./vendor/composer/installed.json -``` - -### Using programmatic checks to cancel the execution of a task and its dependencies - -In addition to `status` checks, `preconditions` checks are the logical inverse of `status` checks. That is, if you need a certain set of conditions to be _true_ you can use the `preconditions` stanza. `preconditions` are similar to `status` lines, except they support `sh` expansion, and they SHOULD all return 0. - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - preconditions: - - test -f .env - - sh: '[ 1 = 0 ]' - msg: "One doesn't equal Zero, Halting" -``` - -Preconditions can set specific failure messages that can tell a user what steps to take using the `msg` field. - -If a task has a dependency on a sub-task with a precondition, and that precondition is not met - the calling task will fail. Note that a task executed with a failing precondition will not run unless `--force` is given. - -Unlike `status`, which will skip a task if it is up to date and continue executing tasks that depend on it, a `precondition` will fail a task, along with any other tasks that depend on it. - -```yaml -version: '3' - -tasks: - task-will-fail: - preconditions: - - sh: 'exit 1' - - task-will-also-fail: - deps: - - task-will-fail - - task-will-still-fail: - cmds: - - task: task-will-fail - - echo "I will not run" -``` - -### Limiting when tasks run - -If a task executed by multiple `cmds` or multiple `deps` you can control when it is executed using `run`. `run` can also be set at the root of the Taskfile to change the behavior of all the tasks unless explicitly overridden. - -Supported values for `run`: - -- `always` (default) always attempt to invoke the task regardless of the number of previous executions -- `once` only invoke this task once regardless of the number of references -- `when_changed` only invokes the task once for each unique set of variables passed into the task - -```yaml -version: '3' - -tasks: - default: - cmds: - - task: generate-file - vars: { CONTENT: '1' } - - task: generate-file - vars: { CONTENT: '2' } - - task: generate-file - vars: { CONTENT: '2' } - - generate-file: - run: when_changed - deps: - - install-deps - cmds: - - echo {{.CONTENT}} - - install-deps: - run: once - cmds: - - sleep 5 # long operation like installing packages -``` - -### Ensuring required variables are set - -If you want to check that certain variables are set before running a task then you can use `requires`. This is useful when might not be clear to users which variables are needed, or if you want clear message about what is required. Also some tasks could have dangerous side effects if run with un-set variables. - -Using `requires` you specify an array of strings in the `vars` sub-section under `requires`, these strings are variable names which are checked prior to running the task. If any variables are un-set the the task will error and not run. - -Environmental variables are also checked. - -Syntax: - -```yaml -requires: - vars: [] # Array of strings -``` - -:::note - -Variables set to empty zero length strings, will pass the `requires` check. - -::: - -Example of using `requires`: - -```yaml -version: '3' - -tasks: - docker-build: - cmds: - - 'docker build . -t {{.IMAGE_NAME}}:{{.IMAGE_TAG}}' - - # Make sure these variables are set before running - requires: - vars: [IMAGE_NAME, IMAGE_TAG] -``` - -## 変数 - -When doing interpolation of variables, Task will look for the below. They are listed below in order of importance (i.e. most important first): - -- Variables declared in the task definition -- Variables given while calling a task from another (See [Calling another task](#calling-another-task) above) -- Variables of the [included Taskfile](#including-other-taskfiles) (when the task is included) -- Variables of the [inclusion of the Taskfile](#vars-of-included-taskfiles) (when the task is included) -- Global variables (those declared in the `vars:` option in the Taskfile) -- Environment variables - -Example of sending parameters with environment variables: - -```bash -$ TASK_VARIABLE=a-value task do-something -``` - -:::tip - -A special variable `.TASK` is always available containing the task name. - -::: - -Since some shells do not support the above syntax to set environment variables (Windows) tasks also accept a similar style when not at the beginning of the command. - -```bash -$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!" -``` - -Example of locally declared vars: - -```yaml -version: '3' - -tasks: - print-var: - cmds: - - echo "{{.VAR}}" - vars: - VAR: Hello! -``` - -Example of global vars in a `Taskfile.yml`: - -```yaml -version: '3' - -vars: - GREETING: Hello from Taskfile! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -### Dynamic variables - -The below syntax (`sh:` prop in a variable) is considered a dynamic variable. The value will be treated as a command and the output assigned. If there are one or more trailing newlines, the last newline will be trimmed. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go - vars: - GIT_COMMIT: - sh: git log -n 1 --format=%h -``` - -This works for all types of variables. - -## Looping over values - -As of v3.28.0, Task allows you to loop over certain values and execute a command for each. There are a number of ways to do this depending on the type of value you want to loop over. - -### Looping over a static list - -The simplest kind of loop is an explicit one. This is useful when you want to loop over a set of values that are known ahead of time. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: ['foo.txt', 'bar.txt'] - cmd: cat {{ .ITEM }} -``` - -### Looping over your task's sources - -You are also able to loop over the sources of your task: - -```yaml -version: '3' - -tasks: - default: - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{ .ITEM }} -``` - -This will also work if you use globbing syntax in your sources. For example, if you specify a source for `*.txt`, the loop will iterate over all files that match that glob. - -Source paths will always be returned as paths relative to the task directory. If you need to convert this to an absolute path, you can use the built-in `joinPath` function. There are some [special variables](/api/#special-variables) that you may find useful for this. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_DIR: /path/to/dir - dir: '{{.MY_DIR}}' - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{joinPath .MY_DIR .ITEM}} -``` - -### Looping over variables - -To loop over the contents of a variable, you simply need to specify the variable you want to loop over. By default, variables will be split on any whitespace characters. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -If you need to split on a different character, you can do this by specifying the `split` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt,bar.txt - cmds: - - for: { var: MY_VAR, split: ',' } - cmd: cat {{.ITEM}} -``` - -All of this also works with dynamic variables! - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: - sh: find -type f -name '*.txt' - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -### Renaming variables - -If you want to rename the iterator variable to make it clearer what the value contains, you can do so by specifying the `as` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR, as: FILE } - cmd: cat {{.FILE}} -``` - -### Looping over tasks - -Because the `for` property is defined at the `cmds` level, you can also use it alongside the `task` keyword to run tasks multiple times with different variables. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: my-task - vars: - FILE: '{{.ITEM}}' - - my-task: - cmds: - - echo '{{.FILE}}' -``` - -Or if you want to run different tasks depending on the value of the loop: - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: task-{{.ITEM}} - - task-foo: - cmds: - - echo 'foo' - - task-bar: - cmds: - - echo 'bar' -``` - -## CLI引数をコマンドにフォワード - -CLIで`--`が渡されると、次に続く全てのパラメータが、`.CLI_ARGS`という特別な変数に追加されます。 これは引数を別のコマンドにフォワードするのに便利です。 - -以下の例では`yarn install`を実行します。 - -```bash -$ task yarn -- install -``` - -```yaml -version: '3' - -tasks: - yarn: - cmds: - - yarn {{.CLI_ARGS}} -``` - -## `defer`を使ったタスクのクリーンアップ - -With the `defer` keyword, it's possible to schedule cleanup to be run once the task finishes. The difference with just putting it as the last command is that this command will run even when the task fails. - -In the example below, `rm -rf tmpdir/` will run even if the third command fails: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: rm -rf tmpdir/ - - echo 'Do work on tmpdir/' -``` - -If you want to move the cleanup command into another task, that is possible as well: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: { task: cleanup } - - echo 'Do work on tmpdir/' - - cleanup: rm -rf tmpdir/ -``` - -:::info - -Due to the nature of how the [Go's own `defer` work](https://go.dev/tour/flowcontrol/13), the deferred commands are executed in the reverse order if you schedule multiple of them. - -::: - -## Goのテンプレートエンジン - -Task parse commands as [Go's template engine][gotemplate] before executing them. Variables are accessible through dot syntax (`.VARNAME`). - -All functions by the Go's [slim-sprig lib](https://go-task.github.io/slim-sprig/) are available. The following example gets the current date in a given format: - -```yaml -version: '3' - -tasks: - print-date: - cmds: - - echo {{now | date "2006-01-02"}} -``` - -Task also adds the following functions: - -- `OS`: Returns the operating system. Possible values are `windows`, `linux`, `darwin` (macOS) and `freebsd`. -- `ARCH`: return the architecture Task was compiled to: `386`, `amd64`, `arm` or `s390x`. -- `splitLines`: Splits Unix (`\n`) and Windows (`\r\n`) styled newlines. -- `catLines`: Replaces Unix (`\n`) and Windows (`\r\n`) styled newlines with a space. -- `toSlash`: Does nothing on Unix, but on Windows converts a string from `\` path format to `/`. -- `fromSlash`: Opposite of `toSlash`. Does nothing on Unix, but on Windows converts a string from `/` path format to `\`. -- `exeExt`: Returns the right executable extension for the current OS (`".exe"` for Windows, `""` for others). -- `shellQuote`: Quotes a string to make it safe for use in shell scripts. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote) for this. The Bash dialect is assumed. -- `splitArgs`: Splits a string as if it were a command's arguments. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/shell#Fields) - -例: - -```yaml -version: '3' - -tasks: - print-os: - cmds: - - echo '{{OS}} {{ARCH}}' - - echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}' - # This will be path/to/file on Unix but path\to\file on Windows - - echo '{{fromSlash "path/to/file"}}' - enumerated-file: - vars: - CONTENT: | - foo - bar - cmds: - - | - cat << EOF > output.txt - {{range $i, $line := .CONTENT | splitLines -}} - {{printf "%3d" $i}}: {{$line}} - {{end}}EOF -``` - -## ヘルプ - -`task --list`(または`task -l`)を実行すると、説明付きで全てのタスクが一覧表示されます。 Taskfileの例: - -```yaml -version: '3' - -tasks: - build: - desc: Build the go binary. - cmds: - - go build -v -i main.go - - test: - desc: Run all the go tests. - cmds: - - go test -race ./... - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -上記のTaskfileの場合、以下のような出力が表示されます: - -```bash -* build: Build the go binary. -* test: Run all the go tests. -``` - -全てのタスクを見たい場合は、`--list-all`(エイリアス `-a`)のフラグを使用してください。 - -## タスクの概要を表示する - -`task --summary task-name`を実行することでタスクの概要が表示されます。 Taskfileの例: - -```yaml -version: '3' - -tasks: - release: - deps: [build] - summary: | - Release your project to github - - It will build your project before starting the release. - Please make sure that you have set GITHUB_TOKEN before starting. - cmds: - - your-release-tool - - build: - cmds: - - your-build-tool -``` - -`task --summary release`を実行することで、以下のように出力されます: - -``` -task: release - -Release your project to github - -It will build your project before starting the release. -Please make sure that you have set GITHUB_TOKEN before starting. - -dependencies: - - build - -commands: - - your-release-tool -``` - -summaryがない場合はdescriptionが表示されます。 summaryもdescriptionもない場合は警告が表示されます。 - -注意: _概要を表示するときはコマンドは実行されません_。 - -## タスクのエイリアス - -Aliases are alternative names for tasks. They can be used to make it easier and quicker to run tasks with long or hard-to-type names. You can use them on the command line, when [calling sub-tasks](#calling-another-task) in your Taskfile and when [including tasks](#including-other-taskfiles) with aliases from another Taskfile. They can also be used together with [namespace aliases](#namespace-aliases). - -```yaml -version: '3' - -tasks: - generate: - aliases: [gen] - cmds: - - task: gen-mocks - - generate-mocks: - aliases: [gen-mocks] - cmds: - - echo "generating..." -``` - -## タスク名の上書き - -Sometimes you may want to override the task name printed on the summary, up-to-date messages to STDOUT, etc. In this case, you can just set `label:`, which can also be interpolated with variables: - -```yaml -version: '3' - -tasks: - default: - - task: print - vars: - MESSAGE: hello - - task: print - vars: - MESSAGE: world - - print: - label: 'print-{{.MESSAGE}}' - cmds: - - echo "{{.MESSAGE}}" -``` - -## 警告プロンプト - -Warning Prompts are used to prompt a user for confirmation before a task is executed. - -Below is an example using `prompt` with a dangerous command, that is called between two safe commands: - -```yaml -version: '3' - -tasks: - example: - cmds: - - task: not-dangerous - - task: dangerous - - task: another-not-dangerous - - not-dangerous: - cmds: - - echo 'not dangerous command' - - another-not-dangerous: - cmds: - - echo 'another not dangerous command' - - dangerous: - prompt: This is a dangerous command... Do you want to continue? - cmds: - - echo 'dangerous command' -``` - -```bash -❯ task dangerous -task: "This is a dangerous command... Do you want to continue?" [y/N] -``` - -Warning prompts are called before executing a task. If a prompt is denied Task will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue as normal. - -```bash -❯ task example -not dangerous command -task: "This is a dangerous command. Do you want to continue?" [y/N] -y -dangerous command -another not dangerous command -``` - -To skip warning prompts automatically, you can use the `--yes` (alias `-y`) option when calling the task. By including this option, all warnings, will be automatically confirmed, and no prompts will be shown. - -:::caution - -Tasks with prompts always fail by default on non-terminal environments, like a CI, where an `stdin` won't be available for the user to answer. In those cases, use `--yes` (`-y`) to force all tasks with a prompt to run. - -::: - -## サイレントモード - -Silent mode disables the echoing of commands before Task runs it. For the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" -``` - -Normally this will be printed: - -```sh -echo "Print something" -Print something -``` - -With silent mode on, the below will be printed instead: - -```sh -Print something -``` - -There are four ways to enable silent mode: - -- At command level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: echo "Print something" - silent: true -``` - -- At task level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" - silent: true -``` - -- Globally at Taskfile level: - -```yaml -version: '3' - -silent: true - -tasks: - echo: - cmds: - - echo "Print something" -``` - -- Or globally with `--silent` or `-s` flag - -If you want to suppress STDOUT instead, just redirect a command to `/dev/null`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "This will print nothing" > /dev/null -``` - -## ドライランモード - -ドライランモード(`--dry`)は各タスクをコンパイルし、実際にはコマンドの内容は実行せずに、タスク内の各ステップで実行されるコマンドを表示します。 これはTaskfileをデバッグする際に便利です。 - -## エラーを無視する - -コマンド実行時のエラーを無視するオプションがあります。 以下のTaskfileを参照してください: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - exit 1 - - echo "Hello World" -``` - -Taskは`exit 1`を実行した後、実行が中止されます。なぜならステータスコード`1`は`EXIT_FAILURE`を意味するためです。 しかしながら、`ignore_error`を使用することで、実行を継続させることが可能です: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "Hello World" -``` - -`ignore_error`はタスク全体に対しても設定することができます。つまり、全てのコマンドに対してエラーが抑制されます。 一方で`deps`や`cmds`によって呼び出された他のタスクには伝播しないことに注意してください！ - -## 出力構文 - -By default, Task just redirects the STDOUT and STDERR of the running commands to the shell in real-time. This is good for having live feedback for logging printed by commands, but the output can become messy if you have multiple commands running simultaneously and printing lots of stuff. - -To make this more customizable, there are currently three different output options you can choose: - -- `interleaved` (default) -- `group` -- `prefixed` - -To choose another one, just set it to root in the Taskfile: - -```yaml -version: '3' - -output: 'group' - -tasks: - # ... -``` - -The `group` output will print the entire output of a command once after it finishes, so you will not have live feedback for commands that take a long time to run. - -When using the `group` output, you can optionally provide a templated message to print at the start and end of the group. This can be useful for instructing CI systems to group all of the output for a given task, such as with [GitHub Actions' `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) or [Azure Pipelines](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?expand=1&view=azure-devops&tabs=bash#formatting-commands). - -```yaml -version: '3' - -output: - group: - begin: '::group::{{.TASK}}' - end: '::endgroup::' - -tasks: - default: - cmds: - - echo 'Hello, World!' - silent: true -``` - -```bash -$ task default -::group::default -Hello, World! -::endgroup:: -``` - -When using the `group` output, you may swallow the output of the executed command on standard output and standard error if it does not fail (zero exit code). - -```yaml -version: '3' - -silent: true - -output: - group: - error_only: true - -tasks: - passes: echo 'output-of-passes' - errors: echo 'output-of-errors' && exit 1 -``` - -```bash -$ task passes -$ task errors -output-of-errors -task: Failed to run task "errors": exit status 1 -``` - -The `prefix` output will prefix every line printed by a command with `[task-name]` as the prefix, but you can customize the prefix for a command with the `prefix:` attribute: - -```yaml -version: '3' - -output: prefixed - -tasks: - default: - deps: - - task: print - vars: { TEXT: foo } - - task: print - vars: { TEXT: bar } - - task: print - vars: { TEXT: baz } - - print: - cmds: - - echo "{{.TEXT}}" - prefix: 'print-{{.TEXT}}' - silent: true -``` - -```bash -$ task default -[print-foo] foo -[print-bar] bar -[print-baz] baz -``` - -:::tip - -The `output` option can also be specified by the `--output` or `-o` flags. - -::: - -## 対話型CLIアプリケーション - -Task内で対話型CLIアプリケーションを実行する際、時折変な挙動をすることがあり、特に[出力モード](#output-syntax)が`交互`(デフォルト)に設定されていない、または対話型アプリが他のタスクと並行して実行される場合に発生します。 - -`interactive: true`は、これが対話型アプリケーションであることをTaskに伝え、Taskはそれに最適化しようとします: - -```yaml -version: '3' - -tasks: - default: - cmds: - - vim my-file.txt - interactive: true -``` - -対話側アプリをTaskを通して実行する際に依然として問題がある場合は、それについてのIssueを作ってください。 - -## 短いタスク構文 - -Task v3から、デフォルトの設定(例: カスタムな `env:`、`vars`、`desc:`、`silent:`などがない場合)を持つタスクは、より短い構文で記述することができます: - -```yaml -version: '3' - -tasks: - build: go build -v -o ./app{{exeExt}} . - - run: - - task: build - - ./app{{exeExt}} -h localhost -p 8080 -``` - -## `set`と`shopt` - -[`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html)および[`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html)の組み込みコマンドにオプションを渡すことが可能です。 これは、グローバル、タスク、またはコマンドのそれぞれのレベルで設定することができます。 - -```yaml -version: '3' - -set: [pipefail] -shopt: [globstar] - -tasks: - # `globstar` required for double star globs to work - default: echo **/*.go -``` - -:::info - -Taskが使用する[シェルインタプリタライブラリ](https://github.com/mvdan/sh)で利用可能なオプションは全てがあるわけではないことに注意してください。 - -::: - -## タスクのウォッチ - -With the flags `--watch` or `-w` task will watch for file changes and run the task again. This requires the `sources` attribute to be given, so task knows which files to watch. - -The default watch interval is 5 seconds, but it's possible to change it by either setting `interval: '500ms'` in the root of the Taskfile passing it as an argument like `--interval=500ms`. - -Also, it's possible to set `watch: true` in a given task and it'll automatically run in watch mode: - -```yaml -version: '3' - -interval: 500ms - -tasks: - build: - desc: Builds the Go application - watch: true - sources: - - '**/*.go' - cmds: - - go build # ... -``` - -:::info - -Note that when setting `watch: true` to a task, it'll only run in watch mode when running from the CLI via `task my-watch-task`, but won't run in watch mode if called by another task, either directly or as a dependency. - -::: - - - - -[gotemplate]: https://golang.org/pkg/text/template/ diff --git a/docs/i18n/ja-JP/docusaurus-theme-classic/footer.json b/docs/i18n/ja-JP/docusaurus-theme-classic/footer.json deleted file mode 100644 index 24259a01..00000000 --- a/docs/i18n/ja-JP/docusaurus-theme-classic/footer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "link.title.Pages": { - "message": "ページ", - "description": "The title of the footer links column with title=Pages in the footer" - }, - "link.title.Community": { - "message": "コミュニティー", - "description": "The title of the footer links column with title=Community in the footer" - }, - "link.title.Translations": { - "message": "翻訳", - "description": "The title of the footer links column with title=Translations in the footer" - }, - "link.item.label.Installation": { - "message": "インストール方法", - "description": "The label of footer link with label=Installation linking to /installation/" - }, - "link.item.label.Usage": { - "message": "使い方", - "description": "The label of footer link with label=Usage linking to /usage/" - }, - "link.item.label.Donate": { - "message": "寄付", - "description": "The label of footer link with label=Donate linking to /donate/" - }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/go-task/task" - }, - "link.item.label.Twitter": { - "message": "Twitter", - "description": "The label of footer link with label=Twitter linking to https://twitter.com/taskfiledev" - }, - "link.item.label.Mastodon": { - "message": "Mastodon", - "description": "The label of footer link with label=Mastodon linking to https://fosstodon.org/@task" - }, - "link.item.label.Discord": { - "message": "Discord", - "description": "The label of footer link with label=Discord linking to https://discord.gg/6TY36E39UK" - }, - "link.item.label.OpenCollective": { - "message": "OpenCollective", - "description": "The label of footer link with label=OpenCollective linking to https://opencollective.com/task" - } -} diff --git a/docs/i18n/ja-JP/docusaurus-theme-classic/navbar.json b/docs/i18n/ja-JP/docusaurus-theme-classic/navbar.json deleted file mode 100644 index 83727d23..00000000 --- a/docs/i18n/ja-JP/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "title": { - "message": "Task", - "description": "The title in the navbar" - }, - "item.label.Installation": { - "message": "インストール方法", - "description": "Navbar item with label Installation" - }, - "item.label.Usage": { - "message": "使い方", - "description": "Navbar item with label Usage" - }, - "item.label.API": { - "message": "API", - "description": "Navbar item with label API" - }, - "item.label.Donate": { - "message": "寄付", - "description": "Navbar item with label Donate" - }, - "item.label.GitHub": { - "message": "GitHub", - "description": "Navbar item with label GitHub" - }, - "item.label.Twitter": { - "message": "Twitter", - "description": "Navbar item with label Twitter" - }, - "item.label.Mastodon": { - "message": "Mastodon", - "description": "Navbar item with label Mastodon" - }, - "item.label.Discord": { - "message": "Discord", - "description": "Navbar item with label Discord" - } -} diff --git a/docs/i18n/pt-BR/code.json b/docs/i18n/pt-BR/code.json deleted file mode 100644 index c8797225..00000000 --- a/docs/i18n/pt-BR/code.json +++ /dev/null @@ -1,396 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "Esta página travou.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Tente novamente", - "description": "The label of the button to try again when the page crashed" - }, - "theme.NotFound.title": { - "message": "Página não encontrada", - "description": "The title of the 404 page" - }, - "theme.NotFound.p1": { - "message": "Não foi possível encontrar o que você está procurando.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Entre em contato com o proprietário do site que lhe trouxe para cá e lhe informe que o link está quebrado.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.admonition.note": { - "message": "nota", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "dica", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.danger": { - "message": "atenção", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "info", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.caution": { - "message": "cuidado", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Voltar para o topo", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "Arquivo", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Arquivo", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Navegação da página de listagem do blog", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Conteúdo mais novo", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Conteúdo Mais Antigo", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Navegação da página de post do blog", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Postagem mais recente", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Postagem mais antiga", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "Uma postagem|{count} postagens", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} marcadas com \"{tagName}\"", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "Ver todas as etiquetas", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Alternar entre o modo claro e escuro (atual {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "modo escuro", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "modo claro", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.home": { - "message": "Página inicial", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Navegação estrutural", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} itens", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Navegação das páginas da documentação", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Anterior", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Próximo", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "Um documento com etiqueta |{count} documentos com etiquetas", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} com \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Versão: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "Esta é uma documentação não lançada para {siteTitle} versão {versionLabel}.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "Esta é a documentação para {siteTitle} {versionLabel}, que não é mais mantida ativamente.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "Para a documentação atualizada, veja {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "versão mais recente", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Editar essa página", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Link direto para o título", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " em {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " por {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Última atualização{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Versões", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Etiquetas:", - "description": "The label alongside a tag list" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Fechar", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Navegação nas postagens recentes do blog", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Copiado", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Copiar código para a área de transferência", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "Copiar", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Alternar quebra de linha", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "Alternar a categoria colapsável da barra lateral '{label}'", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Idiomas", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "Nesta página", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "Leia Mais", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "Leia mais sobre {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "Leitura de um minuto|Leitura de {readingTime} minutos", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Ocultar barra lateral", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Ocultar barra lateral", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Fechar barra de navegação", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← Voltar ao menu principal", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Alternar barra de navegação", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Expandir barra lateral", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Expandir barra lateral", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.seeAll": { - "message": "Veja todos os {count} resultados" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "Um documento encontrado|{count} documentos encontrados", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Resultado da busca por \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Pesquisar a documentação", - "description": "The search page title for empty query" - }, - "theme.SearchPage.inputPlaceholder": { - "message": "Digite aqui o que você procura", - "description": "The placeholder for search page input" - }, - "theme.SearchPage.inputLabel": { - "message": "Pesquisa", - "description": "The ARIA label for search page input" - }, - "theme.SearchPage.algoliaLabel": { - "message": "Busca feita por Algolia", - "description": "The ARIA label for Algolia mention" - }, - "theme.SearchPage.noResultsText": { - "message": "Nenhum resultado encontrado", - "description": "The paragraph for empty search result" - }, - "theme.SearchPage.fetchingNewResults": { - "message": "Trazendo novos resultados...", - "description": "The paragraph for fetching new search results" - }, - "theme.SearchBar.label": { - "message": "Pesquisa", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchModal.searchBox.resetButtonTitle": { - "message": "Limpar a consulta", - "description": "The label and ARIA label for search box reset button" - }, - "theme.SearchModal.searchBox.cancelButtonText": { - "message": "Cancelar", - "description": "The label and ARIA label for search box cancel button" - }, - "theme.SearchModal.startScreen.recentSearchesTitle": { - "message": "Recente", - "description": "The title for recent searches" - }, - "theme.SearchModal.startScreen.noRecentSearchesText": { - "message": "Nenhuma busca recente", - "description": "The text when no recent searches" - }, - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { - "message": "Salvar esta busca", - "description": "The label for save recent search button" - }, - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { - "message": "Remover esta busca do histórico", - "description": "The label for remove recent search button" - }, - "theme.SearchModal.startScreen.favoriteSearchesTitle": { - "message": "Favorito", - "description": "The title for favorite searches" - }, - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { - "message": "Remover esta busca dos favoritos", - "description": "The label for remove favorite search button" - }, - "theme.SearchModal.errorScreen.titleText": { - "message": "Não foi possível carregar os resultados", - "description": "The title for error screen of search modal" - }, - "theme.SearchModal.errorScreen.helpText": { - "message": "Verifique se a sua conexão de internet está funcionando.", - "description": "The help text for error screen of search modal" - }, - "theme.SearchModal.footer.selectText": { - "message": "para selecionar", - "description": "The explanatory text of the action for the enter key" - }, - "theme.SearchModal.footer.selectKeyAriaLabel": { - "message": "Tecla Enter", - "description": "The ARIA label for the Enter key button that makes the selection" - }, - "theme.SearchModal.footer.navigateText": { - "message": "para navegar", - "description": "The explanatory text of the action for the Arrow up and Arrow down key" - }, - "theme.SearchModal.footer.navigateUpKeyAriaLabel": { - "message": "Seta para cima", - "description": "The ARIA label for the Arrow up key button that makes the navigation" - }, - "theme.SearchModal.footer.navigateDownKeyAriaLabel": { - "message": "Seta para baixo", - "description": "The ARIA label for the Arrow down key button that makes the navigation" - }, - "theme.SearchModal.footer.closeText": { - "message": "para fechar", - "description": "The explanatory text of the action for Escape key" - }, - "theme.SearchModal.footer.closeKeyAriaLabel": { - "message": "Tecla Esc", - "description": "The ARIA label for the Escape key button that close the modal" - }, - "theme.SearchModal.footer.searchByText": { - "message": "Pesquisar por", - "description": "The text explain that the search is making by Algolia" - }, - "theme.SearchModal.noResultsScreen.noResultsText": { - "message": "Nenhum resultado para", - "description": "The text explains that there are no results for the following search" - }, - "theme.SearchModal.noResultsScreen.suggestedQueryText": { - "message": "Tente pesquisar por", - "description": "The text for the suggested query when no results are found for the following search" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsText": { - "message": "Acredita que esta pesquisa devia retornar resultados?", - "description": "The text for the question where the user thinks there are missing results" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { - "message": "Conte para nós.", - "description": "The text for the link to report missing results" - }, - "theme.SearchModal.placeholder": { - "message": "Pesquisar na documentação", - "description": "The placeholder of the input of the DocSearch pop-up modal" - }, - "theme.common.skipToMainContent": { - "message": "Pular para o conteúdo principal", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Etiquetas", - "description": "The title of the tag list page" - } -} diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md b/docs/i18n/pt-BR/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md deleted file mode 100644 index 42d99117..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Introducing Experiments -description: A look at where task is, where it's going and how we're going to get there. -slug: task-in-2023 -authors: - - pd93 -tags: - - experiments - - breaking-changes - - roadmap - - v4 -image: https://i.imgur.com/mErPwqL.png -hide_table_of_contents: false ---- - -Lately, Task has been growing extremely quickly and I've found myself thinking a lot about the future of the project and how we continue to evolve and grow. I'm not much of a writer, but I think one of the things we could do better is to communicate these kinds of thoughts to the community. So, with that in mind, this is the first (hopefully of many) blog posts talking about Task and what we're up to. - - - -## :calendar: So, what have we been up to? - -Over the past 12 months or so, [@andreynering][] (Author and maintainer of the project) and I ([@pd93][]) have been working in our spare time to maintain and improve v3 of Task and we've made some amazing progress. Here are just some of the things we've released in that time: - -- An official [extension for VS Code][vscode-task]. -- Internal Tasks ([#818](https://github.com/go-task/task/pull/818)). -- Task aliases ([#879](https://github.com/go-task/task/pull/879)). -- Looping over tasks ([#1220](https://github.com/go-task/task/pull/1200)). -- A series of refactors to the core codebase to make it more maintainable and extensible. -- Loads of bug fixes and improvements. -- An integration with [Crowdin][crowdin]. Work is in progress on making our docs available in **7 new languages** (Special thanks to all our translators for the huge help with this!). -- And much, much more! :sparkles: - -We're also working on adding some really exciting and highly requested features to Task such as having the ability to run remote Taskfiles ([#1317](https://github.com/go-task/task/issues/1317)). - -None of this would have been possible without the [150 or so (and growing) contributors][contributors] to the project, numerous sponsors and a passionate community of users. Together we have more than doubled the number of GitHub stars to over 8400 :star: since the beginning of 2022 and this continues to accelerate. We can't thank you all enough for your help and support! :rocket: - -[![Star History Chart](https://api.star-history.com/svg?repos=go-task/task&type=Date)](https://star-history.com/#go-task/task&Date) - -## What's next? :thinking: - -It's extremely motivating to see so many people using and loving Task. However, in this time we've also seen an increase in the number of issues and feature requests. In particular, issues that require some kind of breaking change to Task. This isn't a bad thing, but as we grow we need to be more responsible about how we address these changes in a way that ensures stability and compatibility for existing users and their Taskfiles. - -At this point you're probably thinking something like: - -> "But you use [semantic versioning][semver] - Just release a new major version with your breaking changes." - -And you'd be right... sort of. In theory, this sounds great, but the reality is that we don't have the time to commit to a major overhaul of Task in one big bang release. This would require a colossal amount of time and coordination and with full time jobs and personal lives to tend to, this is a difficult commitment to make. Smaller, more frequent major releases are also a significant inconvenience for users as they have to constantly keep up-to-date with our breaking changes. Fortunately, there is a better way. - -## What's going to change? :monocle: - -Going forwards, breaking changes will be allowed into _minor_ versions of Task as "experimental features". To access these features users will need opt-in by enabling feature flags. This will allow us to release new features slowly and gather feedback from the community before making them the default behavior in a future major release. - -To prepare users for the next major release, we will maintain a list of [deprecated features][deprecations] and [experiments][experiments] on our docs website and publish information on how to migrate to the new behavior. - -You can read the [full breaking change proposal][breaking-change-proposal] and view all the [current experiments and their status][experiments-project] on GitHub including the [Gentle Force][gentle-force-experiment] and [Remote Taskfiles][remote-taskfiles-experiment] experiments. - -## What will happen to v2/v3 features? - -v2 has been [officially deprecated][deprecate-version-2-schema]. If you're still using a Taskfile with `version: "2"` at the top we _strongly recommend_ that you upgrade as soon as possible. Removing v2 will allow us to tidy up the codebase and focus on new functionality instead. - -When v4 is released, we will continue to support v3 for a period of time (bug fixes etc). However, since we are moving from a backward-compatibility model to a forwards-compatibility model, **v4 itself will not be backwards compatible with v3**. - -## v4 When? :eyes: - -:man_shrugging: When it's ready. - -In all seriousness, we don't have a timeline for this yet. We'll be working on the most serious deficiencies of the v3 API first and regularly evaluating the state of the project. When we feel its in a good, stable place and we have a clear upgrade path for users and a number of stable experiments, we'll start to think about v4. - -## :wave: Final thoughts - -Task is growing fast and we're excited to see where it goes next. We hope that the steps we're taking to improve the project and our process will help us to continue to grow. As always, if you have any questions or feedback, we encourage you to comment on or open [issues][issues] and [discussions][discussions] on GitHub. Alternatively, you can join us on [Discord][discord]. - -I plan to write more of these blog posts in the future on a variety of Task-related topics, so make sure to check in occasionally and see what we're up to! - - - - -[vscode-task]: https://github.com/go-task/vscode-task -[crowdin]: https://crowdin.com -[contributors]: https://github.com/go-task/task/graphs/contributors -[semver]: https://semver.org -[breaking-change-proposal]: https://github.com/go-task/task/discussions/1191 -[@andreynering]: https://github.com/andreynering -[@pd93]: https://github.com/pd93 -[experiments]: https://taskfile.dev/experiments -[deprecations]: https://taskfile.dev/deprecations -[deprecate-version-2-schema]: https://github.com/go-task/task/issues/1197 -[issues]: https://github.com/go-task/task/issues -[discussions]: https://github.com/go-task/task/discussions -[discord]: https://discord.gg/6TY36E39UK -[experiments-project]: https://github.com/orgs/go-task/projects/1 -[gentle-force-experiment]: https://github.com/go-task/task/issues/1200 -[remote-taskfiles-experiment]: https://github.com/go-task/task/issues/1317 diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-blog/authors.yml b/docs/i18n/pt-BR/docusaurus-plugin-content-blog/authors.yml deleted file mode 100644 index d2fa7539..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-blog/authors.yml +++ /dev/null @@ -1,10 +0,0 @@ -andreynering: - name: Andrey Nering - title: Mantenedor do Task - url: https://github.com/andreynering - image_url: https://github.com/andreynering.png -pd93: - name: Pete Davison - title: Maintainer of Task - url: https://github.com/pd93 - image_url: https://github.com/pd93.png diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current.json b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index f8699d1a..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version.label": { - "message": "Próximo", - "description": "The label for version current" - } -} diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/api_reference.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/api_reference.md deleted file mode 100644 index 9f93f037..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/api_reference.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -slug: /api/ -sidebar_position: 4 -toc_min_heading_level: 2 -toc_max_heading_level: 5 ---- - -# Referência da API - -## Linha de comando - -O comando "task" tem a seguinte sintaxe: - -```bash -task [--flags] [tasks...] [-- CLI_ARGS...] -``` - -:::tip - -If `--` is given, all remaining arguments will be assigned to a special `CLI_ARGS` variable - -::: - -| Abreviação | Modificador | Tipo | Predefinição | Descrição | -| ---------- | --------------------------- | -------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-c` | `--color` | `bool` | `true` | Saída colorida. Habilitado por padrão. Defina o modificador como `false` ou use `NO_COLOR=1` para desativar. | -| `-C` | `--concurrency` | `int` | `0` | Limitar número de tarefas a serem executadas simultaneamente. Zero significa ilimitado. | -| `-d` | `--dir` | `string` | Pasta atual | Define a pasta de execução. | -| `-n` | `--dry` | `bool` | `false` | Compila e imprime as tarefas na ordem em que elas seriam executadas, sem executá-las. | -| `-x` | `--exit-code` | `bool` | `false` | Faz com que o código de saída do comando sendo executado seja repassado pelo Task. | -| `-f` | `--force` | `bool` | `false` | Força a execução mesmo quando a tarefa está atualizada. | -| `-g` | `--global` | `bool` | `false` | Executa o Taskfile global, de `$HOME/Taskfile.{yml,yaml}`. | -| `-h` | `--help` | `bool` | `false` | Mostra a ajuda do Task. | -| `-i` | `--init` | `bool` | `false` | Cria um novo Taskfile.yml na pasta atual. | -| `-I` | `--interval` | `string` | `5s` | Define um intervalo de tempo diferente ao usar `--watch`, o padrão sendo 5 segundos. Este valor deve ser um [Go Duration](https://pkg.go.dev/time#ParseDuration) válido. | -| `-l` | `--list` | `bool` | `false` | Lista as tarefas com descrição do Taskfile atual. | -| `-a` | `--list-all` | `bool` | `false` | Lista todas as tarefas, com ou sem descrição. | -| | `--sort` | `string` | `default` | Muda order das terafas quando listadas.
`default` - Ordem alfabética com as tarefas fo Taskfile raíz listadas por primeiro
`alphanumeric` - Alfabética
`none` - Sem ordenação (mantém a mesma ordem de declaração no Taskfile) | -| | `--json` | `bool` | `false` | Imprime a saída em [JSON](#json-output). | -| `-o` | `--output` | `string` | O padrão é o que está definido no Taskfile, ou então `intervealed`. | Configura o estilo de saída: [`interleaved`/`group`/`prefixed`]. | -| | `--output-group-begin` | `string` | | Formato de mensagem a imprimir antes da saída agrupada de uma tarefa. | -| | `--output-group-end` | `string` | | Formato de mensagem a imprimir depois da saída agrupada de uma tarefa. | -| | `--output-group-error-only` | `bool` | `false` | Oculta saída dos comandos que terminarem sem erro. | -| `-p` | `--parallel` | `bool` | `false` | Executa as tarefas fornecidas na linha de comando em paralelo. | -| `-s` | `--silent` | `bool` | `false` | Desabilita impressão. | -| `-y` | `--yes` | `bool` | `false` | Assuma "sim" como resposta a todos os prompts. | -| | `--status` | `bool` | `false` | Sai com código de saída diferente de zero se alguma das tarefas especificadas não estiver atualizada. | -| | `--summary` | `bool` | `false` | Mostrar resumo sobre uma tarefa. | -| `-t` | `--taskfile` | `string` | `Taskfile.yml` ou `Taskfile.yaml` | | -| `-v` | `--verbose` | `bool` | `false` | Habilita modo verboso. | -| | `--version` | `bool` | `false` | Mostrar versão do Task. | -| `-w` | `--watch` | `bool` | `false` | Habilita o monitoramento de tarefas. | - -## Códigos de saída - -O Task às vezes fecha com códigos de saída específicos. Estes códigos são divididos em três grupos com os seguintes intervalos: - -- General errors (0-99) -- Taskfile errors (100-199) -- Task errors (200-299) - -Uma lista completa dos códigos de saída e suas descrições podem ser encontradas abaixo: - -| Código | Descrição | -| ------ | ----------------------------------------------------------- | -| 0 | Sucesso | -| 1 | Um erro desconhecido ocorreu | -| 100 | Nenhum Arquivo foi encontrado | -| 101 | Um arquivo Taskfile já existe ao tentar inicializar um | -| 102 | O arquivo Taskfile é inválido ou não pode ser analisado | -| 103 | A remote Taskfile could not be downloaded | -| 104 | A remote Taskfile was not trusted by the user | -| 105 | A remote Taskfile was could not be fetched securely | -| 106 | No cache was found for a remote Taskfile in offline mode | -| 107 | No schema version was defined in the Taskfile | -| 200 | A tarefa especificada não pôde ser encontrada | -| 201 | Ocorreu um erro ao executar um comando dentro de uma tarefa | -| 202 | O usuário tentou invocar uma tarefa que é interna | -| 203 | Há várias tarefas com o mesmo nome ou apelido | -| 204 | Uma tarefa foi chamada muitas vezes | -| 205 | A tarefa foi cancelada pelo usuário | -| 206 | A task was not executed due to missing required variables | - -Esses códigos também podem ser encontrados no repositório em [`errors/errors.go`](https://github.com/go-task/task/blob/main/errors/errors.go). - -:::info - -Quando o Task é executado com o modificador `-x`/`--exit-code`, o código de saída de todos os comandos falhados será passado para o usuário. - -::: - -## Saída em JSON - -Quando estiver usando o modificador `--json` em combinação com o modificador `--list` ou `--list-all`, a saída será um objeto JSON com a seguinte estrutura: - -```json -{ - "tasks": [ - { - "name": "", - "desc": "", - "summary": "", - "up_to_date": false, - "location": { - "line": 54, - "column": 3, - "taskfile": "/path/to/Taskfile.yml" - } - } - // ... - ], - "location": "/path/to/Taskfile.yml" -} -``` - -## Variáveis Especiais - -Há algumas variáveis especiais que são acessíveis via template: - -| Variável | Descrição | -| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CLI_ARGS` | Contém todos os argumentos extras passados depois de `--` quando invocando o Task via linha de comando. | -| `CLI_FORCE` | A boolean containing whether the `--force` or `--force-all` flags were set. | -| `TASK` | O nome da tarefa atual. | -| `ROOT_DIR` | O caminho absoluto para o Taskfile raíz. | -| `TASKFILE_DIR` | O caminho absoluto para o Taskfile incluído. | -| `USER_WORKING_DIR` | O caminho absoluto a partir do qual o comando `task` foi invocado. | -| `CHECKSUM` | O "checksum" dos arquivos listados em `sources`. Apenas disponível dentro do atributo `status` e se o método estiver configurado como `checksum`. | -| `TIMESTAMP` | The date object of the greatest timestamp of the files listed in `sources`. Apenas disponível dentro do atributo `status` e se o método estiver configurado como `timestamp`. | -| `TASK_VERSION` | A versão atual do Task. | -| `ITEM` | The value of the current iteration when using the `for` property. Can be changed to a different variable name using `as:`. | - -## ENV - -Some environment variables can be overridden to adjust Task behavior. - -| ENV | Padrão | Descrição | -| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `TASK_TEMP_DIR` | `.task` | Caminho da pasta temporária. Pode ser um caminho relativo ao projeto como `tmp/task` ou um caminho absoluto como `/tmp/.task` ou `~/.task`. | -| `TASK_COLOR_RESET` | `0` | Cor utilizada para branco. | -| `TASK_COLOR_BLUE` | `34` | Cor utilizada para azul. | -| `TASK_COLOR_GREEN` | `32` | Cor utilizada para verde. | -| `TASK_COLOR_CYAN` | `36` | Cor utilizada para ciano. | -| `TASK_COLOR_YELLOW` | `33` | Cor utilizada para amarelo. | -| `TASK_COLOR_MAGENTA` | `35` | Cor utilizada para magenta. | -| `TASK_COLOR_RED` | `31` | Cor utilizada para vermelho. | -| `FORCE_COLOR` | | Forçar saída colorida no terminal. | - -## Esquema do Taskfile - -| Atributo | Tipo | Padrão | Descrição | -| ---------- | ---------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `version` | `string` | | Versão do Taskfile. A versão mais atual é a `3`. | -| `output` | `string` | `interleaved` | Mode de saída. Opções disponíveis: `interleaved`, `group` e `prefixed`. | -| `method` | `string` | `checksum` | O método padrão deste Taskfile. Can be overridden in a task by task basis. Opções disponíveis: `checksum` (conteúdo dos arquivos), `timestamp` (data/hora de modificação) e `none` (nenhum). | -| `includes` | [`map[string]Include`](#include) | | Taskfiles adicionais a serem incluídos. | -| `vars` | [`map[string]Variable`](#variable) | | Um conjunto de variáveis globais. | -| `env` | [`map[string]Variable`](#variable) | | Um conjunto de variáveis de ambiente globais. | -| `tasks` | [`map[string]Task`](#task) | | Um conjunto de tarefas. | -| `silent` | `bool` | `false` | Opção padrão para `silent` para este Taskfile. If `false`, can be overridden with `true` in a task by task basis. | -| `dotenv` | `[]string` | | Uma lista de arquivos `.env` para serem incluídos. | -| `run` | `string` | `always` | Opção padrão para `run` para este Taskfile. Opções disponíveis: `always` (sempre), `once` (uma vez) e `when_changed` (quando mudou). | -| `interval` | `string` | `5s` | Configura um intervalo de tempo diferente para `--watch`, sendo que o padrão é de 5 segundos. Essa string deve ser um [Go Duration](https://pkg.go.dev/time#ParseDuration) válido. | -| `set` | `[]string` | | Configura opções para o builtin [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Configura opções para o builtin [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -### Include - -| Atributo | Tipo | Padrão | Descrição | -| ---------- | --------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `taskfile` | `string` | | The path for the Taskfile or directory to be included. If a directory, Task will look for files named `Taskfile.yml` or `Taskfile.yaml` inside that directory. If a relative path, resolved relative to the directory containing the including Taskfile. | -| `dir` | `string` | The parent Taskfile directory | The working directory of the included tasks when run. | -| `optional` | `bool` | `false` | If `true`, no errors will be thrown if the specified file does not exist. | -| `internal` | `bool` | `false` | Stops any task in the included Taskfile from being callable on the command line. These commands will also be omitted from the output when used with `--list`. | -| `aliases` | `[]string` | | Alternative names for the namespace of the included Taskfile. | -| `vars` | `map[string]Variable` | | A set of variables to apply to the included Taskfile. | - -:::info - -Informing only a string like below is equivalent to setting that value to the `taskfile` attribute. - -```yaml -includes: - foo: ./path -``` - -::: - -### Variable - -| Atributo | Tipo | Padrão | Descrição | -| -------- | -------- | ------ | ------------------------------------------------------------------------ | -| _itself_ | `string` | | A static value that will be set to the variable. | -| `sh` | `string` | | A shell command. The output (`STDOUT`) will be assigned to the variable. | - -:::info - -Static and dynamic variables have different syntaxes, like below: - -```yaml -vars: - STATIC: static - DYNAMIC: - sh: echo "dynamic" -``` - -::: - -### Task - -| Atributo | Tipo | Padrão | Descrição | -| --------------- | ---------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmds` | [`[]Command`](#command) | | A list of shell commands to be executed. | -| `deps` | [`[]Dependency`](#dependency) | | A list of dependencies of this task. Tasks defined here will run in parallel before this task. | -| `label` | `string` | | Overrides the name of the task in the output when a task is run. Supports variables. | -| `desc` | `string` | | A short description of the task. This is displayed when calling `task --list`. | -| `prompt` | `string` | | A prompt that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks. | -| `summary` | `string` | | A longer description of the task. This is displayed when calling `task --summary [task]`. | -| `aliases` | `[]string` | | A list of alternative names by which the task can be called. | -| `sources` | `[]string` | | A list of sources to check before running this task. Relevant for `checksum` and `timestamp` methods. Can be file paths or star globs. | -| `generates` | `[]string` | | A list of files meant to be generated by this task. Relevant for `timestamp` method. Can be file paths or star globs. | -| `status` | `[]string` | | A list of commands to check if this task should run. The task is skipped otherwise. This overrides `method`, `sources` and `generates`. | -| `requires` | `[]string` | | A list of variables which should be set if this task is to run, if any of these variables are unset the task will error and not run. | -| `preconditions` | [`[]Precondition`](#precondition) | | A list of commands to check if this task should run. If a condition is not met, the task will error. | -| `requires` | [`Requires`](#requires) | | A list of required variables which should be set if this task is to run, if any variables listed are unset the task will error and not run. | -| `dir` | `string` | | The directory in which this task should run. Defaults to the current working directory. | -| `vars` | [`map[string]Variable`](#variable) | | A set of variables that can be used in the task. | -| `env` | [`map[string]Variable`](#variable) | | A set of environment variables that will be made available to shell commands. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. When combined with the `--list` flag, task descriptions will be hidden. | -| `interactive` | `bool` | `false` | Tells task that the command is interactive. | -| `internal` | `bool` | `false` | Stops a task from being callable on the command line. It will also be omitted from the output when used with `--list`. | -| `method` | `string` | `checksum` | Defines which method is used to check the task is up-to-date. `timestamp` will compare the timestamp of the sources and generates files. `checksum` will check the checksum (You probably want to ignore the .task folder in your .gitignore file). `none` skips any validation and always run the task. | -| `prefix` | `string` | | Defines a string to prefix the output of tasks running in parallel. Only used when the output mode is `prefixed`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing commands. | -| `run` | `string` | The one declared globally in the Taskfile or `always` | Specifies whether the task should run again or not if called more than once. Available options: `always`, `once` and `when_changed`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the task should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Task will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -These alternative syntaxes are available. They will set the given values to `cmds` and everything else will be set to their default values: - -```yaml -tasks: - foo: echo "foo" - - foobar: - - echo "foo" - - echo "bar" - - baz: - cmd: echo "baz" -``` - -::: - -#### Command - -| Atributo | Tipo | Padrão | Descrição | -| -------------- | ---------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmd` | `string` | | The shell command to be executed. | -| `task` | `string` | | Set this to trigger execution of another task instead of running a command. This cannot be set together with `cmd`. | -| `for` | [`For`](#for) | | Runs the command once for each given value. | -| `silent` | `bool` | `false` | Skips some output for this command. Note that STDOUT and STDERR of the commands will still be redirected. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to the referenced task. Only relevant when setting `task` instead of `cmd`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing the command. | -| `defer` | `string` | | Alternative to `cmd`, but schedules the command to be executed at the end of this task instead of immediately. This cannot be used together with `cmd`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the command should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Command will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -If given as a a string, the value will be assigned to `cmd`: - -```yaml -tasks: - foo: - cmds: - - echo "foo" - - echo "bar" -``` - -::: - -#### Dependency - -| Atributo | Tipo | Padrão | Descrição | -| -------- | ---------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------- | -| `task` | `string` | | The task to be execute as a dependency. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to this task. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. | - -:::tip - -If you don't want to set additional variables, it's enough to declare the dependency as a list of strings (they will be assigned to `task`): - -```yaml -tasks: - foo: - deps: [foo, bar] -``` - -::: - -#### For - -The `for` parameter can be defined as a string, a list of strings or a map. If it is defined as a string, you can give it any of the following values: - -- `source` - Will run the command for each source file defined on the task. (Glob patterns will be resolved, so `*.go` will run for every Go file that matches). - -If it is defined as a list of strings, the command will be run for each value. - -Finally, the `for` parameter can be defined as a map when you want to use a variable to define the values to loop over: - -| Atributo | Tipo | Padrão | Descrição | -| -------- | -------- | ---------------- | -------------------------------------------- | -| `var` | `string` | | The name of the variable to use as an input. | -| `split` | `string` | (any whitespace) | What string the variable should be split on. | -| `as` | `string` | `ITEM` | The name of the iterator variable. | - -#### Precondition - -| Attribute | Type | Default | Description | -| --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | -| `sh` | `string` | | Command to be executed. If a non-zero exit code is returned, the task errors without executing its commands. | -| `msg` | `string` | | Optional message to print if the precondition isn't met. | - -:::tip - -If you don't want to set a different message, you can declare a precondition like this and the value will be assigned to `sh`: - -```yaml -tasks: - foo: - precondition: test -f Taskfile.yml -``` - -::: - -#### Requires - -| Attribute | Type | Default | Description | -| --------- | ---------- | ------- | -------------------------------------------------------------------------------------------------- | -| `vars` | `[]string` | | List of variable or environment variable names that must be set if this task is to execute and run | diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/changelog.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/changelog.md deleted file mode 100644 index 628d35e1..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/changelog.md +++ /dev/null @@ -1,573 +0,0 @@ ---- -slug: /changelog/ -sidebar_position: 14 ---- - -# Changelog - -## v3.33.1 - 2023-12-21 - -- Added support for looping over map variables with the [Any Variables experiment](https://taskfile.dev/experiments/any_variables) enabled (#1435, #1437 by @pd93). -- Fixed a bug where dynamic variables were causing errors during fast compilation (#1435, #1437 by @pd93) - -## v3.33.0 - 2023-12-20 - -- Added [Any Variables experiment](https://taskfile.dev/experiments/any-variables) (#1415, #1421 by @pd93). -- Updated Docusaurus to v3 (#1432 by @pd93). -- Added `aliases` to `--json` flag output (#1430, #1431 by @pd93). -- Added new `CLI_FORCE` special variable containing whether the `--force` or `--force-all` flags were set (#1412, #1434 by @pd93). - -## v3.32.0 - 2023-11-29 - -- Added ability to exclude some files from `sources:` by using `exclude:` (#225, - - # 1324 by @pd93 and @andreynering). -- The [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) now prefers remote files over cached ones by default (#1317, #1345 by @pd93). -- Added `--timeout` flag to the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1345 by @pd93). -- Fix bug where dynamic `vars:` and `env:` were being executed when they should actually be skipped by `platforms:` (#1273, #1377 by @andreynering). -- Fix `schema.json` to make `silent` valid in `cmds` that use `for` (#1385, - - # 1386 by @iainvm). -- Add new `--no-status` flag to skip expensive status checks when running `task --list --json` (#1348, #1368 by @amancevice). - -## v3.31.0 - 2023-10-07 - -- Enabled the `--yes` flag for the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1344 by @pd93). -- Add ability to set `watch: true` in a task to automatically run it in watch mode (#231, #1361 by @andreynering). -- Fixed a bug on the watch mode where paths that contained `.git` (like `.github`), for example, were also being ignored (#1356 by @butuzov). -- Fixed a nil pointer error when running a Taskfile with no contents (#1341, - - # 1342 by @pd93). -- Added a new [exit code](https://taskfile.dev/api/#exit-codes) (107) for when a Taskfile does not contain a schema version (#1342 by @pd93). -- Increased limit of maximum task calls from 100 to 1000 for now, as some people have been reaching this limit organically now that we have loops. This check exists to detect recursive calls, but will be removed in favor of a better algorithm soon (#1321, #1332). -- Fixed templating on descriptions on `task --list` (#1343 by @blackjid). -- Fixed a bug where precondition errors were incorrectly being printed when task execution was aborted (#1337, #1338 by @sylv-io). - -## v3.30.1 - 2023-09-14 - -- Fixed a regression where some special variables weren't being set correctly (#1331, #1334 by @pd93). - -## v3.30.0 - 2023-09-13 - -- Prep work for Remote Taskfiles (#1316 by @pd93). -- Added the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) as a draft (#1152, #1317 by @pd93). -- Improve performance of content checksuming on `sources:` by replacing md5 with [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking change because checksums will be invalidated when upgrading to this release (#1325 by @ReillyBrogan). - -## v3.29.1 - 2023-08-26 - -- Update to Go 1.21 (bump minimum version to 1.20) (#1302 by @pd93) -- Fix a missing a line break on log when using `--watch` mode (#1285, #1297 by @FilipSolich). -- Fix `defer` on JSON Schema (#1288 by @calvinmclean and @andreynering). -- Fix bug in usage of special variables like `{{.USER_WORKING_DIR}}` in combination with `includes` (#1046, #1205, #1250, #1293, #1312, #1274 by @andarto, #1309 by @andreynering). -- Fix bug on `--status` flag. Running this flag should not have side-effects: it should not update the checksum on `.task`, only report its status (#1305, - - # 1307 by @visciang, #1313 by @andreynering). - -## v3.28.0 - 2023-07-24 - -- Added the ability to [loop over commands and tasks](https://taskfile.dev/usage/#looping-over-values) using `for` (#82, #1220 by @pd93). -- Fixed variable propagation in multi-level includes (#778, #996, #1256 by @hudclark). -- Fixed a bug where the `--exit-code` code flag was not returning the correct exit code when calling commands indirectly (#1266, #1270 by @pd93). -- Fixed a `nil` panic when a dependency was commented out or left empty (#1263 by @neomantra). - -## v3.27.1 - 2023-06-30 - -- Fix panic when a `.env` directory (not file) is present on current directory (#1244, #1245 by @pd93). - -## v3.27.0 - 2023-06-29 - -- Allow Taskfiles starting with lowercase characters (#947, #1221 by @pd93). - - e.g. `taskfile.yml`, `taskfile.yaml`, `taskfile.dist.yml` & `taskfile.dist.yaml` -- Bug fixes were made to the [npm installation method](https://taskfile.dev/installation/#npm). (#1190, by @sounisi5011). -- Added the [gentle force experiment](https://taskfile.dev/experiments/gentle-force) as a draft (#1200, #1216 by @pd93). -- Added an `--experiments` flag to allow you to see which experiments are enabled (#1242 by @pd93). -- Added ability to specify which variables are required in a task (#1203, #1204 by @benc-uk). - -## v3.26.0 - 2023-06-10 - -- Only rewrite checksum files in `.task` if the checksum has changed (#1185, - - # 1194 by @deviantintegral). -- Added [experiments documentation](https://taskfile.dev/experiments) to the website (#1198 by @pd93). -- Deprecated `version: 2` schema. This will be removed in the next major release (#1197, #1198, #1199 by @pd93). -- Added a new `prompt:` prop to set a warning prompt to be shown before running a potential dangurous task (#100, #1163 by @MaxCheetham, [Documentation](https://taskfile.dev/usage/#warning-prompts)). -- Added support for single command task syntax. With this change, it's now possible to declare just `cmd:` in a task, avoiding the more complex `cmds: []` when you have only a single command for that task (#1130, #1131 by @timdp). - -## v3.25.0 - 2023-05-22 - -- Support `silent:` when calling another tasks (#680, #1142 by @danquah). -- Improve PowerShell completion script (#1168 by @trim21). -- Add more languages to the website menu and show translation progress percentage (#1173 by @misitebao). -- Starting on this release, official binaries for FreeBSD will be available to download (#1068 by @andreynering). -- Fix some errors being unintendedly supressed (#1134 by @clintmod). -- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - - # 1149 by @pd93). -- Fix duplicate error message when a task does not exists (#1141, #1144 by @pd93). - -## v3.24.0 - 2023-04-15 - -- Fix Fish shell completion for tasks with aliases (#1113 by @patricksjackson). -- The default branch was renamed from `master` to `main` (#1049, #1048 by @pd93). -- Fix bug where "up-to-date" logs were not being omitted for silent tasks (#546, - - # 1107 by @danquah). -- Add `.hg` (Mercurial) to the list of ignored directories when using `--watch` (#1098 by @misery). -- More improvements to the release tool (#1096 by @pd93). -- Enforce [gofumpt](https://github.com/mvdan/gofumpt) linter (#1099 by @pd93) -- Add `--sort` flag for use with `--list` and `--list-all` (#946, #1105 by @pd93). -- Task now has [custom exit codes](https://taskfile.dev/api/#exit-codes) depending on the error (#1114 by @pd93). - -## v3.23.0 - 2023-03-26 - -Task now has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task) contributed by @pd93! :tada: The extension is maintained in a [new repository](https://github.com/go-task/vscode-task) under the `go-task` organization. We're looking to gather feedback from the community so please give it a go and let us know what you think via a [discussion](https://github.com/go-task/vscode-task/discussions), [issue](https://github.com/go-task/vscode-task/issues) or on our [Discord](https://discord.gg/6TY36E39UK)! - -> **NOTE:** The extension _requires_ v3.23.0 to be installed in order to work. - -- The website was integrated with [Crowdin](https://crowdin.com/project/taskfile) to allow the community to contribute with translations! [Chinese](https://taskfile.dev/zh-Hans/) is the first language available (#1057, #1058 by @misitebao). -- Added task location data to the `--json` flag output (#1056 by @pd93) -- Change the name of the file generated by `task --init` from `Taskfile.yaml` to `Taskfile.yml` (#1062 by @misitebao). -- Added new `splitArgs` template function (`{{splitArgs "foo bar 'foo bar baz'"}}`) to ensure string is split as arguments (#1040, #1059 by @dhanusaputra). -- Fix the value of `{{.CHECKSUM}}` variable in status (#1076, #1080 by @pd93). -- Fixed deep copy implementation (#1072 by @pd93) -- Created a tool to assist with releases (#1086 by @pd93). - -## v3.22.0 - 2023-03-10 - -- Add a brand new `--global` (`-g`) flag that will run a Taskfile from your `$HOME` directory. This is useful to have automation that you can run from anywhere in your system! ([Documentation](https://taskfile.dev/usage/#running-a-global-taskfile), #1029 by @andreynering). -- Add ability to set `error_only: true` on the `group` output mode. This will instruct Task to only print a command output if it returned with a non-zero exit code (#664, #1022 by @jaedle). -- Fixed bug where `.task/checksum` file was sometimes not being created when task also declares a `status:` (#840, #1035 by @harelwa, #1037 by @pd93). -- Refactored and decoupled fingerprinting from the main Task executor (#1039 by @pd93). -- Fixed deadlock issue when using `run: once` (#715, #1025 by @theunrepentantgeek). - -## v3.21.0 - 2023-02-22 - -- Added new `TASK_VERSION` special variable (#990, #1014 by @ja1code). -- Fixed a bug where tasks were sometimes incorrectly marked as internal (#1007 by @pd93). -- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) -- Added environment variable `FORCE_COLOR` support to force color output. Usefull for environments without TTY (#1003 by @automation-stack) - -## v3.20.0 - 2023-01-14 - -- Improve behavior and performance of status checking when using the `timestamp` mode (#976, #977 by @aminya). -- Performance optimizations were made for large Taskfiles (#982 by @pd93). -- Add ability to configure options for the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins (#908, #929 by @pd93, [Documentation](http://taskfile.dev/usage/#set-and-shopt)). -- Add new `platforms:` attribute to `task` and `cmd`, so it's now possible to choose in which platforms that given task or command will be run on. Possible values are operating system (GOOS), architecture (GOARCH) or a combination of the two. Example: `platforms: [linux]`, `platforms: [amd64]` or `platforms: [linux/amd64]`. Other platforms will be skipped (#978, #980 by @leaanthony). - -## v3.19.1 - 2022-12-31 - -- Small bug fix: closing `Taskfile.yml` once we're done reading it (#963, #964 by @HeCorr). -- Fixes a bug in v2 that caused a panic when using a `Taskfile_{{OS}}.yml` file (#961, #971 by @pd93). -- Fixed a bug where watch intervals set in the Taskfile were not being respected (#969, #970 by @pd93) -- Add `--json` flag (alias `-j`) with the intent to improve support for code editors and add room to other possible integrations. This is basic for now, but we plan to add more info in the near future (#936 by @davidalpert, #764). - -## v3.19.0 - 2022-12-05 - -- Installation via npm now supports [pnpm](https://pnpm.io/) as well ([go-task/go-npm#2](https://github.com/go-task/go-npm/issues/2), [go-task/go-npm#3](https://github.com/go-task/go-npm/pull/3)). -- It's now possible to run Taskfiles from subdirectories! A new `USER_WORKING_DIR` special variable was added to add even more flexibility for monorepos (#289, #920). -- Add task-level `dotenv` support (#389, #904). -- It's now possible to use global level variables on `includes` (#942, #943). -- The website got a brand new [translation to Chinese](https://task-zh.readthedocs.io/zh_CN/latest/) by [@DeronW](https://github.com/DeronW). Thanks! - -## v3.18.0 - 2022-11-12 - -- Show aliases on `task --list --silent` (`task --ls`). This means that aliases will be completed by the completion scripts (#919). -- Tasks in the root Taskfile will now be displayed first in `--list`/`--list-all` output (#806, #890). -- It's now possible to call a `default` task in an included Taskfile by using just the namespace. For example: `docs:default` is now automatically aliased to `docs` (#661, #815). - -## v3.17.0 - 2022-10-14 - -- Add a "Did you mean ...?" suggestion when a task does not exits another one with a similar name is found (#867, #880). -- Now YAML parse errors will print which Taskfile failed to parse (#885, #887). -- Add ability to set `aliases` for tasks and namespaces (#268, #340, #879). -- Improvements to Fish shell completion (#897). -- Added ability to set a different watch interval by setting `interval: '500ms'` or using the `--interval=500ms` flag (#813, #865). -- Add colored output to `--list`, `--list-all` and `--summary` flags (#845, - - # 874). -- Fix unexpected behavior where `label:` was being shown instead of the task name on `--list` (#603, #877). - -## v3.16.0 - 2022-09-29 - -- Add `npm` as new installation method: `npm i -g @go-task/cli` (#870, #871, [npm package](https://www.npmjs.com/package/@go-task/cli)). -- Add support to marking tasks and includes as internal, which will hide them from `--list` and `--list-all` (#818). - -## v3.15.2 - 2022-09-08 - -- Fix error when using variable in `env:` introduced in the previous release (#858, #866). -- Fix handling of `CLI_ARGS` (`--`) in Bash completion (#863). -- On zsh completion, add ability to replace `--list-all` with `--list` as already possible on the Bash completion (#861). - -## v3.15.0 - 2022-09-03 - -- Add new special variables `ROOT_DIR` and `TASKFILE_DIR`. This was a highly requested feature (#215, #857, [Documentation](https://taskfile.dev/api/#special-variables)). -- Follow symlinks on `sources` (#826, #831). -- Improvements and fixes to Bash completion (#835, #844). - -## v3.14.1 - 2022-08-03 - -- Always resolve relative include paths relative to the including Taskfile (#822, #823). -- Fix ZSH and PowerShell completions to consider all tasks instead of just the public ones (those with descriptions) (#803). - -## v3.14.0 - 2022-07-08 - -- Add ability to override the `.task` directory location with the `TASK_TEMP_DIR` environment variable. -- Allow to override Task colors using environment variables: `TASK_COLOR_RESET`, `TASK_COLOR_BLUE`, `TASK_COLOR_GREEN`, `TASK_COLOR_CYAN`, `TASK_COLOR_YELLOW`, `TASK_COLOR_MAGENTA` and `TASK_COLOR_RED` (#568, #792). -- Fixed bug when using the `output: group` mode where STDOUT and STDERR were being print in separated blocks instead of in the right order (#779). -- Starting on this release, ARM architecture binaries are been released to Snap as well (#795). -- i386 binaries won't be available anymore on Snap because Ubuntu removed the support for this architecture. -- Upgrade mvdan.cc/sh, which fixes a bug with associative arrays (#785, [mvdan/sh#884](https://github.com/mvdan/sh/issues/884), [mvdan/sh#893](https://github.com/mvdan/sh/pull/893)). - -## v3.13.0 - 2022-06-13 - -- Added `-n` as an alias to `--dry` (#776, #777). -- Fix behavior of interrupt (SIGINT, SIGTERM) signals. Task will now give time for the processes running to do cleanup work (#458, #479, #728, #769). -- Add new `--exit-code` (`-x`) flag that will pass-through the exit form the command being ran (#755). - -## v3.12.1 - 2022-05-10 - -- Fixed bug where, on Windows, variables were ending with `\r` because we were only removing the final `\n` but not `\r\n` (#717). - -## v3.12.0 - 2022-03-31 - -- The `--list` and `--list-all` flags can now be combined with the `--silent` flag to print the task names only, without their description (#691). -- Added support for multi-level inclusion of Taskfiles. This means that included Taskfiles can also include other Taskfiles. Before this was limited to one level (#390, #623, #656). -- Add ability to specify vars when including a Taskfile. [Check out the documentation](https://taskfile.dev/#/usage?id=vars-of-included-taskfiles) for more information (#677). - -## v3.11.0 - 2022-02-19 - -- Task now supports printing begin and end messages when using the `group` output mode, useful for grouping tasks in CI systems. [Check out the documentation](http://taskfile.dev/#/usage?id=output-syntax) for more information (#647, #651). -- Add `Taskfile.dist.yml` and `Taskfile.dist.yaml` to the supported file name list. [Check out the documentation](https://taskfile.dev/#/usage?id=supported-file-names) for more information (#498, #666). - -## v3.10.0 - 2022-01-04 - -- A new `--list-all` (alias `-a`) flag is now available. It's similar to the exiting `--list` (`-l`) but prints all tasks, even those without a description (#383, #401). -- It's now possible to schedule cleanup commands to run once a task finishes with the `defer:` keyword ([Documentation](https://taskfile.dev/#/usage?id=doing-task-cleanup-with-defer), - - # 475, #626). -- Remove long deprecated and undocumented `$` variable prefix and `^` command prefix (#642, #644, #645). -- Add support for `.yaml` extension (as an alternative to `.yml`). This was requested multiple times throughout the years. Enjoy! (#183, #184, #369, #584, - - # 621). -- Fixed error when computing a variable when the task directory do not exist yet (#481, #579). - -## v3.9.2 - 2021-12-02 - -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains a fix a for a important regression on Windows (#619, [mvdan/sh#768](https://github.com/mvdan/sh/issues/768), [mvdan/sh#769](https://github.com/mvdan/sh/pull/769)). - -## v3.9.1 - 2021-11-28 - -- Add logging in verbose mode for when a task starts and finishes (#533, #588). -- Fix an issue with preconditions and context errors (#597, #598). -- Quote each `{{.CLI_ARGS}}` argument to prevent one with spaces to become many (#613). -- Fix nil pointer when `cmd:` was left empty (#612, #614). -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains two relevant fixes: - - Fix quote of empty strings in `shellQuote` (#609, [mvdan/sh#763](https://github.com/mvdan/sh/issues/763)). - - Fix issue of wrong environment variable being picked when there's another very similar one (#586, [mvdan/sh#745](https://github.com/mvdan/sh/pull/745)). -- Install shell completions automatically when installing via Homebrew (#264, #592, [go-task/homebrew-tap#2](https://github.com/go-task/homebrew-tap/pull/2)). - -## v3.9.0 - 2021-10-02 - -- A new `shellQuote` function was added to the template system (`{{shellQuote "a string"}}`) to ensure a string is safe for use in shell ([mvdan/sh#727](https://github.com/mvdan/sh/pull/727), [mvdan/sh#737](https://github.com/mvdan/sh/pull/737), [Documentation](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)) -- In this version [mvdan.cc/sh](https://github.com/mvdan/sh) was upgraded with some small fixes and features - - The `read -p` flag is now supported (#314, [mvdan/sh#551](https://github.com/mvdan/sh/issues/551), [mvdan/sh#772](https://github.com/mvdan/sh/pull/722)) - - The `pwd -P` and `pwd -L` flags are now supported (#553, [mvdan/sh#724](https://github.com/mvdan/sh/issues/724), [mvdan/sh#728](https://github.com/mvdan/sh/pull/728)) - - The `$GID` environment variable is now correctly being set (#561, [mvdan/sh#723](https://github.com/mvdan/sh/pull/723)) - -## v3.8.0 - 2021-09-26 - -- Add `interactive: true` setting to improve support for interactive CLI apps (#217, #563). -- Fix some `nil` errors (#534, #573). -- Add ability to declare an included Taskfile as optional (#519, #552). -- Add support for including Taskfiles in the home directory by using `~` (#539, #557). - -## v3.7.3 - 2021-09-04 - -- Add official support to Apple M1 (#564, #567). -- Our [official Homebrew tap](https://github.com/go-task/homebrew-tap) will support more platforms, including Apple M1 - -## v3.7.0 - 2021-07-31 - -- Add `run:` setting to control if tasks should run multiple times or not. Available options are `always` (the default), `when_changed` (if a variable modified the task) and `once` (run only once no matter what). This is a long time requested feature. Enjoy! (#53, #359). - -## v3.6.0 - 2021-07-10 - -- Allow using both `sources:` and `status:` in the same task (#411, #427, #477). -- Small optimization and bug fix: don't compute variables if not needed for `dotenv:` (#517). - -## v3.5.0 - 2021-07-04 - -- Add support for interpolation in `dotenv:` (#433, #434, #453). - -## v3.4.3 - 2021-05-30 - -- Add support for the `NO_COLOR` environment variable. (#459, [fatih/color#137](https://github.com/fatih/color/pull/137)). -- Fix bug where sources were not considering the right directory in `--watch` mode (#484, #485). - -## v3.4.2 - 2021-04-23 - -- On watch, report which file failed to read (#472). -- Do not try to catch SIGKILL signal, which are not actually possible (#476). -- Improve version reporting when building Task from source using Go Modules (#462, #473). - -## v3.4.1 - 2021-04-17 - -- Improve error reporting when parsing YAML: in some situations where you would just see an generic error, you'll now see the actual error with more detail: the YAML line the failed to parse, for example (#467). -- A JSON Schema was published [here](https://json.schemastore.org/taskfile.json) and is automatically being used by some editors like Visual Studio Code (#135). -- Print task name before the command in the log output (#398). - -## v3.3.0 - 2021-03-20 - -- Add support for delegating CLI arguments to commands with `--` and a special `CLI_ARGS` variable (#327). -- Add a `--concurrency` (alias `-C`) flag, to limit the number of tasks that run concurrently. This is useful for heavy workloads. (#345). - -## v3.2.2 - 2021-01-12 - -- Improve performance of `--list` and `--summary` by skipping running shell variables for these flags (#332). -- Fixed a bug where an environment in a Taskfile was not always overridable by the system environment (#425). -- Fixed environment from .env files not being available as variables (#379). -- The install script is now working for ARM platforms (#428). - -## v3.2.1 - 2021-01-09 - -- Fixed some bugs and regressions regarding dynamic variables and directories (#426). -- The [slim-sprig](https://github.com/go-task/slim-sprig) package was updated with the upstream [sprig](https://github.com/Masterminds/sprig). - -## v3.2.0 - 2021-01-07 - -- Fix the `.task` directory being created in the task directory instead of the Taskfile directory (#247). -- Fix a bug where dynamic variables (those declared with `sh:`) were not running in the task directory when the task has a custom dir or it was in an included Taskfile (#384). -- The watch feature (via the `--watch` flag) got a few different bug fixes and should be more stable now (#423, #365). - -## v3.1.0 - 2021-01-03 - -- Fix a bug when the checksum up-to-date resolution is used by a task with a custom `label:` attribute (#412). -- Starting from this release, we're releasing official ARMv6 and ARM64 binaries for Linux (#375, #418). -- Task now respects the order of declaration of included Taskfiles when evaluating variables declaring by them (#393). -- `set -e` is now automatically set on every command. This was done to fix an issue where multiline string commands wouldn't really fail unless the sentence was in the last line (#403). - -## v3.0.1 - 2020-12-26 - -- Allow use as a library by moving the required packages out of the `internal` directory (#358). -- Do not error if a specified dotenv file does not exist (#378, #385). -- Fix panic when you have empty tasks in your Taskfile (#338, #362). - -## v3.0.0 - 2020-08-16 - -- On `v3`, all CLI variables will be considered global variables (#336, #341) -- Add support to `.env` like files (#324, #356). -- Add `label:` to task so you can override the task name in the logs (#321, - - # 337). -- Refactor how variables work on version 3 (#311). -- Disallow `expansions` on v3 since it has no effect. -- `Taskvars.yml` is not automatically included anymore. -- `Taskfile_{{OS}}.yml` is not automatically included anymore. -- Allow interpolation on `includes`, so you can manually include a Taskfile based on operation system, for example. -- Expose `.TASK` variable in templates with the task name (#252). -- Implement short task syntax (#194, #240). -- Added option to make included Taskfile run commands on its own directory (#260, #144) -- Taskfiles in version 1 are not supported anymore (#237). -- Added global `method:` option. With this option, you can set a default method to all tasks in a Taskfile (#246). -- Changed default method from `timestamp` to `checksum` (#246). -- New magic variables are now available when using `status:`: `.TIMESTAMP` which contains the greatest modification date from the files listed in `sources:`, and `.CHECKSUM`, which contains a checksum of all files listed in `status:`. This is useful for manual checking when using external, or even remote, artifacts when using `status:` (#216). -- We're now using [slim-sprig](https://github.com/go-task/slim-sprig) instead of [sprig](https://github.com/Masterminds/sprig), which allowed a file size reduction of about 22% (#219). -- We now use some colors on Task output to better distinguish message types - commands are green, errors are red, etc (#207). - -## v2.8.1 - 2020-05-20 - -- Fix error code for the `--help` flag (#300, #330). -- Print version to stdout instead of stderr (#299, #329). -- Supress `context` errors when using the `--watch` flag (#313, #317). -- Support templating on description (#276, #283). - -## v2.8.0 - 2019-12-07 - -- Add `--parallel` flag (alias `-p`) to run tasks given by the command line in parallel (#266). -- Fixed bug where calling the `task` CLI only informing global vars would not execute the `default` task. -- Add hability to silent all tasks by adding `silent: true` a the root of the Taskfile. - -## v2.7.1 - 2019-11-10 - -- Fix error being raised when `exit 0` was called (#251). - -## v2.7.0 - 2019-09-22 - -- Fixed panic bug when assigning a global variable (#229, #243). -- A task with `method: checksum` will now re-run if generated files are deleted (#228, #238). - -## v2.6.0 - 2019-07-21 - -- Fixed some bugs regarding minor version checks on `version:`. -- Add `preconditions:` to task (#205). -- Create directory informed on `dir:` if it doesn't exist (#209, #211). -- We now have a `--taskfile` flag (alias `-t`), which can be used to run another Taskfile (other than the default `Taskfile.yml`) (#221). -- It's now possible to install Task using Homebrew on Linux ([go-task/homebrew-tap#1](https://github.com/go-task/homebrew-tap/pull/1)). - -## v2.5.2 - 2019-05-11 - -- Reverted YAML upgrade due issues with CRLF on Windows (#201, [go-yaml/yaml#450](https://github.com/go-yaml/yaml/issues/450)). -- Allow setting global variables through the CLI (#192). - -## 2.5.1 - 2019-04-27 - -- Fixed some issues with interactive command line tools, where sometimes the output were not being shown, and similar issues (#114, #190, #200). -- Upgraded [go-yaml/yaml](https://github.com/go-yaml/yaml) from v2 to v3. - -## v2.5.0 - 2019-03-16 - -- We moved from the taskfile.org domain to the new fancy taskfile.dev domain. While stuff is being redirected, we strongly recommend to everyone that use [this install script](https://taskfile.dev/#/installation?id=install-script) to use the new taskfile.dev domain on scripts from now on. -- Fixed to the ZSH completion (#182). -- Add [`--summary` flag along with `summary:` task attribute](https://taskfile.org/#/usage?id=display-summary-of-task) (#180). - -## v2.4.0 - 2019-02-21 - -- Allow calling a task of the root Taskfile from an included Taskfile by prefixing it with `:` (#161, #172). -- Add flag to override the `output` option (#173). -- Fix bug where Task was persisting the new checksum on the disk when the Dry Mode is enabled (#166). -- Fix file timestamp issue when the file name has spaces (#176). -- Mitigating path expanding issues on Windows (#170). - -## v2.3.0 - 2019-01-02 - -- On Windows, Task can now be installed using [Scoop](https://scoop.sh/) (#152). -- Fixed issue with file/directory globing (#153). -- Added ability to globally set environment variables (#138, #159). - -## v2.2.1 - 2018-12-09 - -- This repository now uses Go Modules (#143). We'll still keep the `vendor` directory in sync for some time, though; -- Fixing a bug when the Taskfile has no tasks but includes another Taskfile (#150); -- Fix a bug when calling another task or a dependency in an included Taskfile (#151). - -## v2.2.0 - 2018-10-25 - -- Added support for [including other Taskfiles](https://taskfile.org/#/usage?id=including-other-taskfiles) (#98) - - This should be considered experimental. For now, only including local files is supported, but support for including remote Taskfiles is being discussed. If you have any feedback, please comment on #98. -- Task now have a dedicated documentation site: https://taskfile.org - - Thanks to [Docsify](https://docsify.js.org/) for making this pretty easy. To check the source code, just take a look at the [docs](https://github.com/go-task/task/tree/main/docs) directory of this repository. Contributions to the documentation is really appreciated. - -## v2.1.1 - 2018-09-17 - -- Fix suggestion to use `task --init` not being shown anymore (when a `Taskfile.yml` is not found) -- Fix error when using checksum method and no file exists for a source glob (#131) -- Fix signal handling when the `--watch` flag is given (#132) - -## v2.1.0 - 2018-08-19 - -- Add a `ignore_error` option to task and command (#123) -- Add a dry run mode (`--dry` flag) (#126) - -## v2.0.3 - 2018-06-24 - -- Expand environment variables on "dir", "sources" and "generates" (#116) -- Fix YAML merging syntax (#112) -- Add ZSH completion (#111) -- Implement new `output` option. Please check out the [documentation](https://github.com/go-task/task#output-syntax) - -## v2.0.2 - 2018-05-01 - -- Fix merging of YAML anchors (#112) - -## v2.0.1 - 2018-03-11 - -- Fixes panic on `task --list` - -## v2.0.0 - 2018-03-08 - -Version 2.0.0 is here, with a new Taskfile format. - -Please, make sure to read the [Taskfile versions](https://github.com/go-task/task/blob/main/TASKFILE_VERSIONS.md) document, since it describes in depth what changed for this version. - -- New Taskfile version 2 (#77) -- Possibility to have global variables in the `Taskfile.yml` instead of `Taskvars.yml` (#66) -- Small improvements and fixes - -## v1.4.4 - 2017-11-19 - -- Handle SIGINT and SIGTERM (#75); -- List: print message with there's no task with description; -- Expand home dir ("~" symbol) on paths (#74); -- Add Snap as an installation method; -- Move examples to its own repo; -- Watch: also walk on tasks called on on "cmds", and not only on "deps"; -- Print logs to stderr instead of stdout (#68); -- Remove deprecated `set` keyword; -- Add checksum based status check, alternative to timestamp based. - -## v1.4.3 - 2017-09-07 - -- Allow assigning variables to tasks at run time via CLI (#33) -- Added suport for multiline variables from sh (#64) -- Fixes env: remove square braces and evaluate shell (#62) -- Watch: change watch library and few fixes and improvements -- When use watching, cancel and restart long running process on file change (#59 and #60) - -## v1.4.2 - 2017-07-30 - -- Flag to set directory of execution -- Always echo command if is verbose mode -- Add silent mode to disable echoing of commands -- Fixes and improvements of variables (#56) - -## v1.4.1 - 2017-07-15 - -- Allow use of YAML for dynamic variables instead of $ prefix - - `VAR: {sh: echo Hello}` instead of `VAR: $echo Hello` -- Add `--list` (or `-l`) flag to print existing tasks -- OS specific Taskvars file (e.g. `Taskvars_windows.yml`, `Taskvars_linux.yml`, etc) -- Consider task up-to-date on equal timestamps (#49) -- Allow absolute path in generates section (#48) -- Bugfix: allow templating when calling deps (#42) -- Fix panic for invalid task in cyclic dep detection -- Better error output for dynamic variables in Taskvars.yml (#41) -- Allow template evaluation in parameters - -## v1.4.0 - 2017-07-06 - -- Cache dynamic variables -- Add verbose mode (`-v` flag) -- Support to task parameters (overriding vars) (#31) (#32) -- Print command, also when "set:" is specified (#35) -- Improve task command help text (#35) - -## v1.3.1 - 2017-06-14 - -- Fix glob not working on commands (#28) -- Add ExeExt template function -- Add `--init` flag to create a new Taskfile -- Add status option to prevent task from running (#27) -- Allow interpolation on `generates` and `sources` attributes (#26) - -## v1.3.0 - 2017-04-24 - -- Migrate from os/exec.Cmd to a native Go sh/bash interpreter - - This is a potentially breaking change if you use Windows. - - Now, `cmd` is not used anymore on Windows. Always use Bash-like syntax for your commands, even on Windows. -- Add "ToSlash" and "FromSlash" to template functions -- Use functions defined on github.com/Masterminds/sprig -- Do not redirect stdin while running variables commands -- Using `context` and `errgroup` packages (this will make other tasks to be cancelled, if one returned an error) - -## v1.2.0 - 2017-04-02 - -- More tests and Travis integration -- Watch a task (experimental) -- Possibility to call another task -- Fix "=" not being reconized in variables/environment variables -- Tasks can now have a description, and help will print them (#10) -- Task dependencies now run concurrently -- Support for a default task (#16) - -## v1.1.0 - 2017-03-08 - -- Support for YAML, TOML and JSON (#1) -- Support running command in another directory (#4) -- `--force` or `-f` flag to force execution of task even when it's up-to-date -- Detection of cyclic dependencies (#5) -- Support for variables (#6, #9, #14) -- Operation System specific commands and variables (#13) - -## v1.0.0 - 2017-02-28 - -- Add LICENSE file diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/community.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/community.md deleted file mode 100644 index 50208692..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/community.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -slug: /community/ -sidebar_position: 9 ---- - -# Comunidade - -Some of the work to improve the Task ecosystem is done by the community, be it installation methods or integrations with code editor. I (the author) am thankful for everyone that helps me to improve the overall experience. - -## Translations - -We use [Crowdin](https://crowdin.com/project/taskfile) to translate our document. - -## Integrations - -Many of our integrations are contributed and maintained by the community. You can view the full list of community integrations [here](/integrations#community-integrations). - -## Installation methods - -Some installation methods are maintained by third party: - -- [GitHub Actions](https://github.com/arduino/setup-task) by @arduino -- [AUR](https://aur.archlinux.org/packages/go-task-bin) by @carlsmedstad -- [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json) -- [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) -- [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/go-task/default.nix) -- [Conda](https://github.com/conda-forge/go-task-feedstock/) - -## More - -Also, thanks for all the [code contributors](https://github.com/go-task/task/graphs/contributors), [financial contributors](https://opencollective.com/task), all those who [reported bugs](https://github.com/go-task/task/issues?q=is%3Aissue) and [answered questions](https://github.com/go-task/task/discussions). - -If you know something that is missing in this document, please submit a pull request. diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/contributing.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/contributing.md deleted file mode 100644 index 57b2aa7b..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/contributing.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -slug: /contributing/ -sidebar_position: 11 ---- - -# Contributing - -Contributions to Task are very welcome, but we ask that you read this document before submitting a PR. - -:::note - -This document applies to the core [Task][task] repository _and_ [Task for Visual Studio Code][vscode-task]. - -::: - -## Before you start - -- **Check existing work** - Is there an existing PR? Are there issues discussing the feature/change you want to make? Please make sure you consider/address these discussions in your work. -- **Backwards compatibility** - Will your change break existing Taskfiles? It is much more likely that your change will merged if it backwards compatible. Is there an approach you can take that maintains this compatibility? If not, consider opening an issue first so that API changes can be discussed before you invest your time into a PR. -- **Experiments** - If there is no way to make your change backward compatible then there is a procedure to introduce breaking changes into minor versions. We call these "\[experiments\]\[experiments\]". If you're intending to work on an experiment, then please read the \[experiments workflow\]\[experiments-workflow\] document carefully and submit a proposal first. - -## 1. Setup - -- **Go** - Task is written in [Go][go]. We always support the latest two major Go versions, so make sure your version is recent enough. -- **Node.js** - [Node.js][nodejs] is used to host Task's documentation server and is required if you want to run this server locally. It is also required if you want to contribute to the Visual Studio Code extension. -- **Yarn** - [Yarn][yarn] is the Node.js package manager used by Task. - -## 2. Making changes - -- **Code style** - Try to maintain the existing code style where possible. Go code should be formatted by [`gofumpt`][gofumpt] and linted using [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be formatted and linted by [Prettier][prettier]. This style is enforced by our CI to ensure that we have a consistent style across the project. You can use the `task lint` command to lint the code locally and the `task lint:fix` command to automatically fix any issues that are found. -- **Documentation** - Ensure that you add/update any relevant documentation. See the [updating documentation](#updating-documentation) section below. -- **Tests** - Ensure that you add/update any relevant tests and that all tests are passing before submitting the PR. See the [writing tests](#writing-tests) section below. - -### Running your changes - -To run Task with working changes, you can use `go run ./cmd/task`. To run a development build of task against a test Taskfile in `testdata`, you can use `go run ./cmd/task --dir ./testdata/ `. - -To run Task for Visual Studio Code, you can open the project in VSCode and hit F5 (or whatever you debug keybind is set to). This will open a new VSCode window with the extension running. Debugging this way is recommended as it will allow you to set breakpoints and step through the code. Otherwise, you can run `task package` which will generate a `.vsix` file that can be used to manually install the extension. - -### Updating documentation - -Task uses [Docusaurus][docusaurus] to host a documentation server. The code for this is located in the core Task repository. This can be setup and run locally by using `task docs` (requires `nodejs` & `yarn`). All content is written in Markdown and is located in the `docs/docs` directory. All Markdown documents should have an 80 character line wrap limit (enforced by Prettier). - -When making a change, consider whether a change to the [Usage Guide](/usage) is necessary. This document contains descriptions and examples of how to use Task features. If you're adding a new feature, try to find an appropriate place to add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](/styleguide). - -If you added a new field, command or flag, ensure that you add it to the [API Reference](/api). New fields also need to be added to the [JSON Schema][json-schema]. The descriptions for fields in the API reference and the schema should match. - -### Writing tests - -A lot of Task's tests are held in the `task_test.go` file in the project root and this is where you'll most likely want to add new ones too. Most of these tests also have a subdirectory in the `testdata` directory where any Taskfiles/data required to run the tests are stored. - -When making a changes, consider whether new tests are required. These tests should ensure that the functionality you are adding will continue to work in the future. Existing tests may also need updating if you have changed Task's behavior. - -You may also consider adding unit tests for any new functions you have added. The unit tests should follow the Go convention of being location in a file named `*_test.go` in the same package as the code being tested. - -## 3. Committing your code - -Try to write meaningful commit messages and avoid having too many commits on the PR. Most PRs should likely have a single commit (although for bigger PRs it may be reasonable to split it in a few). Git squash and rebase is your friend! - -If you're not sure how to format your commit message, check out [Conventional Commits][conventional-commits]. This style is not enforced, but it is a good way to make your commit messages more readable and consistent. - -## 4. Submitting a PR - -- **Describe your changes** - Ensure that you provide a comprehensive description of your changes. -- **Issue/PR links** - Link any previous work such as related issues or PRs. Please describe how your changes differ to/extend this work. -- **Examples** - Add any examples or screenshots that you think are useful to demonstrate the effect of your changes. -- **Draft PRs** - If your changes are incomplete, but you would like to discuss them, open the PR as a draft and add a comment to start a discussion. Using comments rather than the PR description allows the description to be updated later while preserving any discussions. - -## FAQ - -> I want to contribute, where do I start? - -Take a look at the list of [open issues for Task][task-open-issues] or [Task for Visual Studio Code][vscode-task-open-issues]. We have a [good first issue][good-first-issue] label for simpler issues that are ideal for first time contributions. - -All kinds of contributions are welcome, whether its a typo fix or a shiny new feature. You can also contribute by upvoting/commenting on issues, helping to answer questions or contributing to other [community projects](/community). - -> I'm stuck, where can I get help? - -If you have questions, feel free to ask them in the `#help` forum channel on our [Discord server][discord-server] or open a [Discussion][discussion] on GitHub. - ---- - - - - -[task]: https://github.com/go-task/task -[vscode-task]: https://github.com/go-task/vscode-task -[go]: https://go.dev -[gofumpt]: https://github.com/mvdan/gofumpt -[golangci-lint]: https://golangci-lint.run -[prettier]: https://prettier.io -[nodejs]: https://nodejs.org/en/ -[yarn]: https://yarnpkg.com/ -[docusaurus]: https://docusaurus.io -[json-schema]: https://github.com/go-task/task/blob/main/docs/static/schema.json -[task-open-issues]: https://github.com/go-task/task/issues -[vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues -[good-first-issue]: https://github.com/go-task/task/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 -[discord-server]: https://discord.gg/6TY36E39UK -[discussion]: https://github.com/go-task/task/discussions -[conventional-commits]: https://www.conventionalcommits.org diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/deprecations/deprecations.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/deprecations/deprecations.md deleted file mode 100644 index 965b26d1..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/deprecations/deprecations.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: /deprecations/ -sidebar_position: 7 ---- - -# Deprecations - -As Task evolves, it occasionally outgrows some of its functionality. This can be because they are no longer useful, because another feature has replaced it or because of a change in the way that Task works internally. - -When this happens, we mark the functionality as deprecated. This means that it will be removed in a future version of Task. This functionality will continue to work until that time, but we strongly recommend that you do not implement this functionality in new Taskfiles and make a plan to migrate away from it as soon as possible. - -You can view a full list of active deprecations in the "Deprecations" section of the sidebar. diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/deprecations/template.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/deprecations/template.md deleted file mode 100644 index 646e45c6..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/deprecations/template.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Deprecated Feature\} (#\{Issue\}) - -:::warning - -This deprecation breaks the following functionality: - -- \{list any existing functionality that will be broken by this deprecation\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -\{Short description of the feature/behavior and why it is being deprecated\} - -\{Short explanation of any replacement features/behaviors and how users should migrate to it\} diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md deleted file mode 100644 index c45fb65d..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -slug: /deprecations/version-2-schema/ ---- - -# Version 2 Schema (#1197) - -:::warning - -This deprecation breaks the following functionality: - -- Any Taskfiles that use the version 2 schema -- `Taskvar.yml` files - -::: - -The Taskfile version 2 schema was introduced in March 2018 and replaced by version 3 in August 2019. In May 2023 [we published a deprecation notice][deprecation-notice] for the version 2 schema on the basis that the vast majority of users had already upgraded to version 3 and removing support for version 2 would allow us to tidy up the codebase and focus on new functionality instead. - -In December 2023, the final version of Task that supports the version 2 schema ([v3.33.0][v3.33.0]) was published and all legacy code was removed from Task's main branch. To use a more recent version of Task, you will need to ensure that your Taskfile uses the version 3 schema instead. A list of changes between version 2 and version 3 are available in the [Task v3 Release Notes][v3.0.0]. - - - - -[v3.0.0]: https://github.com/go-task/task/releases/tag/v3.0.0 -[v3.33.0]: https://github.com/go-task/task/releases/tag/v3.33.0 -[deprecation-notice]: https://github.com/go-task/task/issues/1197 diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/donate.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/donate.md deleted file mode 100644 index dd9f1833..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/donate.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: /donate/ -sidebar_position: 16 ---- - -# Doe - -Se você acha esse projeto útil, considere doar usando um dos meios listados abaixo. - -Esta é apenas uma maneira de dizer "obrigado", ele não lhe dará nenhum benefício como maior prioridade em issues ou algo parecido. - -As empresas que doarem pelo menos $50/mês ganharão destaque como "Patrocinador Ouro" na página do site e no README do repositório no GitHub. Faça contato com [@andreynering][] com o logotipo que você deseja ser mostrado no site. Negócios suspeitos (apostas, cassinos, etc) não serão permitidos, porém. - -## GitHub Sponsors - -A forma sugerida de doar para os mantenedores é através do GitHub Sponsors. Just use the following links to do your donation. We suggest a 50/50 split to each maintainer of the total amount you plan to donate to the project. - -- [@andreynering](https://github.com/sponsors/andreynering) -- [@pd93](https://github.com/sponsors/pd93) - -## Open Collective - -Se você preferir o [Open Collective](https://opencollective.com/task) você pode doar usando um destes links: - -- [$2 por mês](https://opencollective.com/task/contribute/backer-4034/checkout) -- [$5 por mês](https://opencollective.com/task/contribute/supporter-8404/checkout) -- [$20 por mês](https://opencollective.com/task/contribute/sponsor-4035/checkout) -- [$50 por mês](https://opencollective.com/task/contribute/sponsor-28775/checkout) -- [Valor personalizado - Essa opção também suporta doar uma única vez](https://opencollective.com/task/donate) - -## PayPal - -Você pode doar para [@andreynering][] através do PayPal também: - -- [Qualquer valor - Doação única](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GSVDU63RKG45A¤cy_code=USD&source=url) - -## PIX (somente para o Brasil) - -E se você é brasileiro, também pode doar para [@andreynering][] via PIX [usando este QR Code](/img/pix.png). - - - - -[@andreynering]: https://github.com/andreynering diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/any_variables.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/any_variables.md deleted file mode 100644 index cf2521c7..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/any_variables.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables (#1415) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any -time_. We strongly recommend that you do not use these features in a production -environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- Dynamically defined variables (using the `sh` keyword) - -::: - -:::info - -To enable this experiment, set the environment variable: -`TASK_X_ANY_VARIABLES=1`. Check out [our guide to enabling experiments -][enabling-experiments] for more information. - -::: - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the [slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for "collection-type" variables, the `for` -keyword has been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -This also works for maps. When looping over a map we also make an additional -`{{.KEY}}` variable availabe that holds the string value of the map key. -Remember that maps are unordered, so the order in which the items are looped -over is random: - -```yaml -version: 3 - -tasks: - foo: - vars: - MAP: - KEY_1: - SUBKEY: sub_value_1 - KEY_2: - SUBKEY: sub_value_2 - KEY_3: - SUBKEY: sub_value_3 - cmds: - - for: - var: MAP - cmd: echo {{.KEY}} {{.ITEM.SUBKEY}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[enabling-experiments]: /experiments/#enabling-experiments - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx deleted file mode 100644 index 73cdcd80..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables - -- Issue: #1415 -- Environment variable: `TASK_X_ANY_VARIABLES=1` -- Breaks: - - Dynamically defined variables (using the `sh` keyword) - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the -[slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for array variables, the `for` keyword has -been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/experiments.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/experiments.md deleted file mode 100644 index b1a70473..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/experiments.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -slug: /experiments/ -sidebar_position: 6 ---- - -# Experiments - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -In order to allow Task to evolve quickly, we roll out breaking changes to minor versions behind experimental flags. This allows us to gather feedback on breaking changes before committing to a major release. This document describes the current set of experimental features and their status in the [workflow](#workflow). - -You can view a full list of active experiments in the "Experiments" section of the sidebar. - -## Enabling Experiments - -You can enable an experimental feature by doing one of the following: - -1. Using the relevant environment variable in front of a task command. For example, `TASK_X_{FEATURE}=1 task {my-task}`. This is intended for one-off invocations of Task to test out experimental features. -1. Using the relevant environment variable in your "dotfiles" (e.g. `.bashrc`, `.zshrc` etc.). This is intended for permanently enabling experimental features in your environment. -1. Creating a `.env` file in the same directory as your root Taskfile that contains the relevant environment variables. This allows you to enable an experimental feature at a project level. For example: - -```shell title=".env" -TASK_X_FEATURE=1 -``` - -## Current Experimental Features and Deprecations - -Each section below details an experiment or deprecation and explains what the flags/environment variables to enable the experiment are and how the feature's behavior will change. It will also explain what you need to do to migrate any existing Taskfiles to the new behavior. - -## Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -### 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -### 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -### 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -### 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -### 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -### Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/gentle_force.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/gentle_force.md deleted file mode 100644 index 514602bb..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/gentle_force.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -slug: /experiments/gentle-force/ ---- - -# Gentle Force (#1200) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- The `--force` flag - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_FORCE=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -The `--force` flag currently forces _all_ tasks to run regardless of the status checks. This can be useful, but we have found that most of the time users only expect the direct task they are calling to be forced and _not_ all of its dependant tasks. - -This experiment changes the `--force` flag to only force the directly called task. All dependant tasks will have their statuses checked as normal and will only run if Task considers them to be out of date. A new `--force-all` flag will also be added to maintain the current behavior for users that need this functionality. - -If you want to migrate, but continue to force all dependant tasks to run, you should replace all uses of the `--force` flag with `--force-all`. Alternatively, if you want to adopt the new behavior, you can continue to use the `--force` flag as you do now! - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md deleted file mode 100644 index 73a934d8..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -slug: /experiments/remote-taskfiles/ ---- - -# Remote Taskfiles (#1317) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_REMOTE_TASKFILES=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -This experiment allows you to specify a remote Taskfile URL when including a Taskfile. For example: - -```yaml -version: '3' - -includes: - my-remote-namespace: https://raw.githubusercontent.com/my-org/my-repo/main/Taskfile.yml -``` - -This works exactly the same way that including a local file does. Any tasks in the remote Taskfile will be available to run from your main Taskfile via the namespace `my-remote-namespace`. For example, if the remote file contains the following: - -```yaml -version: '3' - -tasks: - hello: - silent: true - cmds: - - echo "Hello from the remote Taskfile!" -``` - -and you run `task my-remote-namespace:hello`, it will print the text: "Hello from the remote Taskfile!" to your console. - -## Security - -Running commands from sources that you do not control is always a potential security risk. For this reason, we have added some checks when using remote Taskfiles: - -1. When running a task from a remote Taskfile for the first time, Task will print a warning to the console asking you to check that you are sure that you trust the source of the Taskfile. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the remote Taskfile will run and further calls to the remote Taskfile will not prompt you again. -2. Whenever you run a remote Taskfile, Task will create and store a checksum of the file that you are running. If the checksum changes, then Task will print another warning to the console to inform you that the contents of the remote file has changed. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the checksum will be updated and the remote Taskfile will run. - -Sometimes you need to run Task in an environment that does not have an interactive terminal, so you are not able to accept a prompt. In these cases you are able to tell task to accept these prompts automatically by using the `--yes` flag. Before enabling this flag, you should: - -1. Be sure that you trust the source and contents of the remote Taskfile. -2. Consider using a pinned version of the remote Taskfile (e.g. A link containing a commit hash) to prevent Task from automatically accepting a prompt that says a remote Taskfile has changed. - -Task currently supports both `http` and `https` URLs. However, the `http` requests will not execute by default unless you run the task with the `--insecure` flag. This is to protect you from accidentally running a remote Taskfile that is hosted on and unencrypted connection. Sources that are not protected by TLS are vulnerable to [man-in-the-middle attacks][man-in-the-middle-attacks] and should be avoided unless you know what you are doing. - -## Caching & Running Offline - -Whenever you run a remote Taskfile, the latest copy will be downloaded from the internet and cached locally. If for whatever reason, you lose access to the internet, you will still be able to run your tasks by specifying the `--offline` flag. This will tell Task to use the latest cached version of the file instead of trying to download it. You are able to use the `--download` flag to update the cached version of the remote files without running any tasks. - -By default, Task will timeout requests to download remote files after 10 seconds and look for a cached copy instead. This timeout can be configured by setting the `--timeout` flag and specifying a duration. For example, `--timeout 5s` will set the timeout to 5 seconds. - - - - -[enabling-experiments]: /experiments/#enabling-experiments -[man-in-the-middle-attacks]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/template.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/template.md deleted file mode 100644 index 59246cf5..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/template.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Experiment\} (#\{Issue\}) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- \{list any existing functionality that will be broken by this experiment\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_{feature}=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -\{Short description of the feature\} - -\{Short explanation of how users should migrate to the new behavior\} - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/workflow.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/workflow.md deleted file mode 100644 index 62aff616..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/experiments/workflow.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /experiments/workflow/ ---- - -# Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -## 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -## 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -## 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -## 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -## 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -## Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/faq.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/faq.md deleted file mode 100644 index 4c443c11..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/faq.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -slug: /faq/ -sidebar_position: 15 ---- - -# Perguntas frequentes - -This page contains a list of frequently asked questions about Task. - -## Why won't my task update my shell environment? - -This is a limitation of how shells work. Task runs as a subprocess of your current shell, so it can't change the environment of the shell that started it. This limitation is shared by other task runners and build tools too. - -A common way to work around this is to create a task that will generate output that can be parsed by your shell. For example, to set an environment variable on your shell you can write a task like this: - -```yaml -my-shell-env: - cmds: - - echo "export FOO=foo" - - echo "export BAR=bar" -``` - -Now run `eval $(task my-shell-env)` and the variables `$FOO` and `$BAR` will be available in your shell. - -## I can't reuse my shell in a task's commands - -Task runs each command as a separate shell process, so something you do in one command won't effect any future commands. For example, this won't work: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - a=foo - - echo $a - # outputs "" -``` - -To work around this you can either use a multiline command: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - | - a=foo - echo $a - # outputs "foo" -``` - -Or for more complex multi-line commands it is recommended to move your code into a separate file and call that instead: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - ./foo-printer.bash -``` - -```bash -#!/bin/bash -a=foo -echo $a -``` - -## 'x' builtin command doesn't work on Windows - -The default shell on Windows (`cmd` and `powershell`) do not have commands like `rm` and `cp` available as builtins. This means that these commands won't work. If you want to make your Taskfile fully cross-platform, you'll need to work around this limitation using one of the following methods: - -- Use the `{{OS}}` function to run an OS-specific script. -- Use something like `{{if eq OS "windows"}}powershell {{end}}` to detect windows and run the command in Powershell directly. -- Use a shell on Windows that supports these commands as builtins, such as [Git Bash][git-bash] or [WSL][wsl]. - -We want to make improvements to this part of Task and the issues below track this work. Constructive comments and contributions are very welcome! - -- #197 -- [mvdan/sh#93](https://github.com/mvdan/sh/issues/93) -- [mvdan/sh#97](https://github.com/mvdan/sh/issues/97) - - - - -[git-bash]: https://gitforwindows.org/ -[wsl]: https://learn.microsoft.com/en-us/windows/wsl/install diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/installation.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/installation.md deleted file mode 100644 index cc4f9306..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/installation.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -slug: /installation/ -sidebar_position: 2 ---- - -# Instalação - -Há muitas maneiras possíveis de se instalar o Task. Confira os métodos disponíveis abaixo. - -## Gerenciador de Pacotes - -### Homebrew - -Se você estiver no macOS ou Linux e tiver o [Homebrew][homebrew] instalado, instalar o Task é tão simples quanto rodar: - -```bash -brew install go-task/tap/go-task -``` - -The above Formula is [maintained by ourselves](https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb). - -Recentemente, o Task também foi disponibilizado [no repositório oficial do Homebrew](https://formulae.brew.sh/formula/go-task), então você também tem essa opção, se preferir: - -```bash -brew install go-task -``` - -### Tea - -If you're on macOS or Linux and have [tea][tea] installed, getting Task is as simple as running: - -```bash -tea task -``` - -or, if you have tea’s magic enabled: - -```bash -task -``` -Este método de instalação é mantido pela comunidade. After a new release of Task, they are automatically released by tea in a minimum of time. - -### Snap - -O Task está disponível no [Snapcraft][snapcraft], mas tenha em mente que a sua distribuição Linux deve suportar confinamento clássico (*classic confinement*) para Snaps para o Task funcionar corretamente: - -```bash -sudo snap install task --classic -``` - -### Chocolatey - -Se você estiver no Windows e tiver o [Chocolatey][choco] instalado, instalar o Task é tão simples quanto rodar: - -```bash -choco install go-task -``` - -Este método de instalação é mantido pela comunidade. - -### Scoop - -Se você está no Windows e tem o [Scoop][scoop] instalado, instalar o Task é tão simples quanto rodar: - -```cmd -scoop install task -``` - -This installation method is community owned. Após o lançamento de uma nova versão do Task, pode levar algum tempo até que esteja disponível no Scoop. - -### AUR - -Se você estiver no Arch Linux, você pode instalar o Task a partir do [AUR](https://aur.archlinux.org/packages/go-task-bin) usando o seu gerenciador de pacotes favorito, como `yay`, `pacauro` ou `yaourt`: - -```cmd -yay -S go-task-bin -``` - -Alternativamente, há [este pacote](https://aur.archlinux.org/packages/go-task) que instala do código fonte ao invés de baixar o binário [do GitHub](https://github.com/go-task/task/releases): - -```cmd -yay -S go-task -``` - -Este método de instalação é mantido pela comunidade. - -### Fedora - -Se você estiver no Fedora Linux, você pode instalar o Task do [repositório oficial do Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) usando `dnf`: - -```cmd -sudo dnf install go-task -``` - -Este método de instalação é mantido pela comunidade. Após o lançamento de uma nova versão do Task, pode levar algum tempo até que ela esteja disponível no [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/). - -### Nix - -Se você estiver no NixOS ou tiver o Nix instalado, você pode instalar o Task a partir do [nixpkgs](https://github.com/NixOS/nixpkgs): - -```cmd -nix-env -iA nixpkgs.go-task -``` - -Este método de instalação é mantido pela comunidade. Após o lançamento de uma nova versão do Task, pode levar algum tempo até que ela esteja disponível em [nixpkgs](https://github.com/NixOS/nixpkgs). - -### npm - -Você também pode usar o Node e o npm para instalar o Task instalando [este pacote](https://www.npmjs.com/package/@go-task/cli). - -```bash -npm install -g @go-task/cli -``` - -### Winget - -Se você estiver usando o Windows e instalando a ferramenta de gerenciamento de pacotes [winget](https://github.com/microsoft/winget-cli), você pode instalar o Task a partir de [winget-pkgs](https://github.com/microsoft/winget-pkgs). - -```bash -winget install Task.Task -``` - -## Baixe o Binário - -### Binário - -Você pode baixar o binário da [página de versões no GitHub][releases] e adicionar a sua variável de ambiente `$PATH`. - -Os pacotes DEB e RPM também estão disponíveis. - -O arquivo `task_checksums.txt` contém a *checksum* SHA-256 para cada arquivo. - -### Script de instalação - -Também temos um [script de instalação][installscript] que é muito útil em cenários, como CI. Muito obrigado ao [GoDownloader][godownloader] por permitir a geração fácil deste script. - -Por padrão, o binário será baixado no diretório `./bin` em relação ao diretório atual: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -``` - -É possível substituir o diretório de instalação com o parâmetro `-b`. No Linux, escolhas comuns são `~/.local/bin` e `~/bin` para instalar para o usuário ou `/usr/local/bin` para instalar para todos os usuários: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin -``` - -:::caution - -No macOS e Windows, `~/.local/bin` e `~/bin` não são adicionados ao `$PATH` por padrão. - -::: - -### GitHub Actions - -Se você quiser instalar o Task no GitHub Actions você pode tentar usar [esta *action*](https://github.com/arduino/setup-task) pela equipe do Arduino: - -```yaml -- name: Install Task - uses: arduino/setup-task@v1 - with: - version: 3.x - repo-token: ${{ secrets.GITHUB_TOKEN }} -``` - -This installation method is community owned. - -## Compilar do código-fonte - -### Go Modules - -Certifique-se de que você tem uma versão suportada do [Go][go] corretamente instalado e configurado. Você pode encontrar a versão mínima necessária do Go no arquivo [go.mod](https://github.com/go-task/task/blob/main/go.mod#L3). - -Você pode então instalar a última versão globalmente ao rodar: - -```bash -go install github.com/go-task/task/v3/cmd/task@latest -``` - -Ou você pode instalar em outro diretório rodando: - -```bash -env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest -``` - -:::tip - -Para ambientes com CI, recomendamos usar o [script de instalação](#install-script), que é mais rápido e mais estável, já que ele apenas baixará o último binário lançado. - -::: - -## Configurar *auto-complete* de terminal - -Baixe o arquivo de *auto-completion* correspondente ao seu terminal. - -[Todos os scripts de *completion* estão disponíveis no repositório do Task](https://github.com/go-task/task/tree/main/completion). - -### Bash - -Primeiro, certifique-se de que você instalou o *bash-completion* usando seu gerenciador de pacotes. - -Torne o arquivo de *completion* executável: - -``` -chmod +x path/to/task.bash -``` - -Depois, adicione isto ao seu `~/.bash_profile`: - -```shell -source path/to/task.bash -``` - -### ZSH - -Coloque o arquivo `_task` em algum lugar no seu `$FPATH`: - -```shell -mv path/to/_task /usr/local/share/zsh/site-functions/_task -``` - -Certifique-se de que o seguinte esteja presente em seu `~/.zshrc`: - -```shell -autoload -U compinit -compinit -i -``` - -Recomenda-se ZSH versão 5.7 ou posterior. - -### Fish - -Mova o script de *completion* `task.fish`: - -```shell -mv path/to/task.fish ~/.config/fish/completions/task.fish -``` - -### PowerShell - -Abra seu *profile script* rodando: - -``` -mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue -notepad $profile -``` - -Adicione a seguinte linha e salve o arquivo: - -```shell -Invoke-Expression -Command path/to/task.ps1 -``` - - - - -[go]: https://golang.org/ -[snapcraft]: https://snapcraft.io/task -[homebrew]: https://brew.sh/ -[installscript]: https://github.com/go-task/task/blob/main/install-task.sh -[releases]: https://github.com/go-task/task/releases -[godownloader]: https://github.com/goreleaser/godownloader -[choco]: https://chocolatey.org/ -[scoop]: https://scoop.sh/ -[tea]: https://tea.xyz/ diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/integrations.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/integrations.md deleted file mode 100644 index b6e4c800..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/integrations.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -slug: /integrations/ -sidebar_position: 8 ---- - -# Integrations - -## Visual Studio Code Extension - -Task has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task). The code for this project can be found [here](https://github.com/go-task/vscode-task). To use this extension, you must have Task v3.23.0+ installed on your system. - -This extension provides the following features (and more): - -- View tasks in the sidebar. -- Run tasks from the sidebar and command palette. -- Go to definition from the sidebar and command palette. -- Run last task command. -- Multi-root workspace support. -- Initialize a Taskfile in the current workspace. - -To get autocompletion and validation for your Taskfile, see the [Schema](#schema) section below. - -![Task for Visual Studio Code](https://github.com/go-task/vscode-task/blob/main/res/preview.png?raw=true) - -## Schema - -This was initially created by @KROSF in [this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and is now officially maintained in [this file](https://github.com/go-task/task/blob/main/docs/static/schema.json) and made available at https://taskfile.dev/schema.json. This schema can be used to validate Taskfiles and provide autocompletion in many code editors: - -### Visual Studio Code - -To integrate the schema into VS Code, you need to install the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) by Red Hat. Any `Taskfile.yml` in your project should automatically be detected and validation/autocompletion should work. If this doesn't work or you want to manually configure it for files with a different name, you can add the following to your `settings.json`: - -```json -// settings.json -{ - "yaml.schemas": { - "https://taskfile.dev/schema.json": [ - "**/Taskfile.yml", - "./path/to/any/other/taskfile.yml" - ] - } -} -``` - -You can also configure the schema directly inside of a Taskfile by adding the following comment to the top of the file: - -```yaml -# yaml-language-server: $schema=https://taskfile.dev/schema.json -version: '3' -``` - -You can find more information on this in the [YAML language server project](https://github.com/redhat-developer/yaml-language-server). - -## Community Integrations - -In addition to our official integrations, there is an amazing community of developers who have created their own integrations for Task: - -- [Sublime Text Plugin](https://packagecontrol.io/packages/Taskfile) [[source](https://github.com/biozz/sublime-taskfile)] by @biozz -- [IntelliJ Plugin](https://plugins.jetbrains.com/plugin/17058-taskfile) [[source](https://github.com/lechuckroh/task-intellij-plugin)] by @lechuckroh -- [mk](https://github.com/pycontribs/mk) command line tool recognizes Taskfiles natively. - -If you have made something that integrates with Task, please feel free to open a PR to add it to this list. diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/intro.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/intro.md deleted file mode 100644 index 2de11624..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/intro.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -slug: / -sidebar_position: 1 -title: Página Inicial ---- - -# Task - -
- -
- -Task é uma ferramenta de automatização que foi criada para ser mais simples de usar do que outras similares, como por exemplo o [GNU Make][make]. - -Por ser escrito em [Go][go], o Task é simplesmente um binário e não possui nenhuma outra dependência, o que significa que você não precisa lidar com um processo de instalação complicado apenas para usar uma ferramenta de automação. - -Once [installed](/installation), you just need to describe your build tasks using a simple [YAML][yaml] schema in a file called `Taskfile.yml`: - -```yaml title="Taskfile.yml" -version: '3' - -tasks: - hello: - cmds: - - echo 'Hello World from Task!' - silent: true -``` - -E invocá-lo ao rodar `task hello` do seu terminal. - -O exemplo acima é apenas o começo. Você pode dar uma olhada no [guia de uso](/usage) para conferir a documentação completa do esquema e as funcionalidades do Task. - -## Features - -- [Easy installation](/installation): just download a single binary, add to `$PATH` and you're done! Ou você também pode instalá-lo usando [Homebrew][homebrew], [Snapcraft][snapcraft] ou [Scoop][scoop] se você quiser. -- Available on CIs: by adding [this simple command](/installation#install-script) to install on your CI script and you're ready to use Task as part of your CI pipeline; -- Verdadeiramente multiplataforma: enquanto a maioria das ferramentas de compilação só funcionam bem no Linux ou macOS, o Task também suporta Windows graças [a este interpretador de shell para Go][sh]. -- Ótimo para a geração de código: você pode facilmente [impedir que uma tarefa execute](/usage#prevent-unnecessary-work) se um determinado conjunto de arquivos não tiver mudado desde a última execução (baseado na data de modificação ou conteúdo dos arquivos). - - - - -[make]: https://www.gnu.org/software/make/ -[go]: https://go.dev/ -[yaml]: http://yaml.org/ -[homebrew]: https://brew.sh/ -[snapcraft]: https://snapcraft.io/ -[scoop]: https://scoop.sh/ -[sh]: https://github.com/mvdan/sh diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/releasing.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/releasing.md deleted file mode 100644 index b232b322..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/releasing.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /releasing/ -sidebar_position: 13 ---- - -# Releasing - -The release process of Task is done with the help of [GoReleaser][goreleaser]. You can test the release process locally by calling the `test-release` task of the Taskfile. - -[GitHub Actions](https://github.com/go-task/task/actions) should release artifacts automatically when a new Git tag is pushed to `main` branch (raw executables and DEB and RPM packages). - -Since v3.15.0, raw executables can also be reproduced and verified locally by checking out a specific tag and calling `goreleaser build`, using the Go version defined in the above GitHub Actions. - -# Homebrew - -Goreleaser will automatically push a new commit to the [Formula/go-task.rb][gotaskrb] file in the [Homebrew tap][homebrewtap] repository to release the new version. - -# npm - -To release to npm update the version in the [`package.json`][packagejson] file and then run `task npm:publish` to push it. - -# Snapcraft - -The [snap package][snappackage] requires to manual steps to release a new version: - -- Updating the current version on [snapcraft.yaml][snapcraftyaml]. -- Moving both `amd64`, `armhf` and `arm64` new artifacts to the stable channel on the [Snapcraft dashboard][snapcraftdashboard]. - -# winget - -winget also requires manual steps to be completed. By running `task goreleaser:test` locally, manifest files will be generated on `dist/winget/manifests/t/Task/Task/v{version}`. [Upload the manifest directory into this fork](https://github.com/go-task/winget-pkgs/tree/master/manifests/t/Task/Task) and open a pull request into [this repository](https://github.com/microsoft/winget-pkgs). - -# Scoop - -Scoop is a command-line package manager for the Windows operating system. Scoop package manifests are maintained by the community. Scoop owners usually take care of updating versions there by editing [this file](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json). If you think its Task version is outdated, open an issue to let us know. - -# Nix - -Nix is a community owned installation method. Nix package maintainers usually take care of updating versions there by editing [this file](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/development/tools/go-task/default.nix). If you think its Task version is outdated, open an issue to let us know. - - - - -[goreleaser]: https://goreleaser.com/ -[homebrewtap]: https://github.com/go-task/homebrew-tap -[gotaskrb]: https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb -[packagejson]: https://github.com/go-task/task/blob/main/package.json#L3 -[snappackage]: https://github.com/go-task/snap -[snapcraftyaml]: https://github.com/go-task/snap/blob/main/snap/snapcraft.yaml#L2 -[snapcraftdashboard]: https://snapcraft.io/task/releases diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/styleguide.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/styleguide.md deleted file mode 100644 index b339aaaa..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/styleguide.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -slug: /styleguide/ -sidebar_position: 10 ---- - -# Guia de estilo - -This is the official Task styleguide for `Taskfile.yml` files. This guide contains some basic instructions to keep your Taskfile clean and familiar to other users. - -This contains general guidelines, but they don't necessarily need to be strictly followed. Feel free to disagree and proceed differently at some point if you need or want to. Also, feel free to open issues or pull requests with improvements to this guide. - -## Use the correct order of keywords - -- `version:` -- `includes:` -- Configuration ones, like `output:`, `silent:`, `method:` and `run:` -- `vars:` -- `env:`, `dotenv:` -- `tasks:` - -## Use 2 spaces for indentation - -This is the most common convention for YAML files, and Task follows it. - -```yaml -# bad -tasks: - foo: - cmds: - - echo 'foo' - - -# good -tasks: - foo: - cmds: - - echo 'foo' -``` - -## Separate with spaces the mains sections - -```yaml -# bad -version: '3' -includes: - docker: ./docker/Taskfile.yml -output: prefixed -vars: - FOO: bar -env: - BAR: baz -tasks: - # ... - - -# good -version: '3' - -includes: - docker: ./docker/Taskfile.yml - -output: prefixed - -vars: - FOO: bar - -env: - BAR: baz - -tasks: - # ... -``` - -## Add spaces between tasks - -```yaml -# bad -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - bar: - cmds: - - echo 'bar' - baz: - cmds: - - echo 'baz' - - -# good -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - - bar: - cmds: - - echo 'bar' - - baz: - cmds: - - echo 'baz' -``` - -## Use upper-case variable names - -```yaml -# bad -version: '3' - -vars: - binary_name: myapp - -tasks: - build: - cmds: - - go build -o {{.binary_name}} . - - -# good -version: '3' - -vars: - BINARY_NAME: myapp - -tasks: - build: - cmds: - - go build -o {{.BINARY_NAME}} . -``` - -## Don't wrap vars in spaces when templating - -```yaml -# bad -version: '3' - -tasks: - greet: - cmds: - - echo '{{ .MESSAGE }}' - - -# good -version: '3' - -tasks: - greet: - cmds: - - echo '{{.MESSAGE}}' -``` - -This convention is also used by most people for any Go templating. - -## Separate task name words with a dash - -```yaml -# bad -version: '3' - -tasks: - do_something_fancy: - cmds: - - echo 'Do something' - - -# good -version: '3' - -tasks: - do-something-fancy: - cmds: - - echo 'Do something' -``` - -## Use colon for task namespacing - -```yaml -# good -version: '3' - -tasks: - docker:build: - cmds: - - docker ... - - docker:run: - cmds: - - docker-compose ... -``` - -This is also done automatically when using included Taskfiles. - -## Prefer external scripts over complex multi-line commands - -```yaml -# bad -version: '3' - -tasks: - build: - cmds: - - | - for i in $(seq 1 10); do - echo $i - echo "some other complex logic" - done' - -# good -version: '3' - -tasks: - build: - cmds: - - ./scripts/my_complex_script.sh -``` diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/taskfile_versions.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/taskfile_versions.md deleted file mode 100644 index 05d3b4d1..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/taskfile_versions.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -slug: /taskfile-versions/ -sidebar_position: 5 ---- - -# Versões do Taskfile - -The Taskfile syntax and features changed with time. This document explains what changed on each version and how to upgrade your Taskfile. - -## What the Taskfile version mean - -The Taskfile version follows the Task version. E.g. the change to Taskfile version `2` means that Task `v2.0.0` should be release to support it. - -The `version:` key on Taskfile accepts a semver string, so either `2`, `2.0` or `2.0.0` is accepted. If you choose to use `2.0` Task will not enable future `2.1` features, but if you choose to use `2`, then any `2.x.x` features will be available, but not `3.0.0+`. - -## Version 3 ![latest](https://img.shields.io/badge/latest-brightgreen) - -These are some major changes done on `v3`: - -- Task's output will now be colored -- Added support for `.env` like files -- Added `label:` setting to task so one can override how the task name appear in the logs -- A global `method:` was added to allow setting the default method, and Task's default changed to `checksum` -- Two magic variables were added when using `status:`: `CHECKSUM` and `TIMESTAMP` which contains, respectively, the XXH3 checksum and greatest modification timestamp of the files listed on `sources:` -- Also, the `TASK` variable is always available with the current task name -- CLI variables are always treated as global variables -- Added `dir:` option to `includes` to allow choosing on which directory an included Taskfile will run: - -```yaml -includes: - docs: - taskfile: ./docs - dir: ./docs -``` - -- Implemented short task syntax. All below syntaxes are equivalent: - -```yaml -version: '3' - -tasks: - print: - cmds: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: echo "Hello, World!" -``` - -- There was a major refactor on how variables are handled. They're now easier to understand. The `expansions:` setting was removed as it became unnecessary. This is the order in which Task will process variables, each level can see the variables set by the previous one and override those. - - Environment variables - - Global + CLI variables - - Call variables - - Task variables - -## Version 2.6 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.6 comes with `preconditions` stanza in tasks. - -```yaml -version: '2' - -tasks: - upload_environment: - preconditions: - - test -f .env - cmds: - - aws s3 cp .env s3://myenvironment -``` - -Please check the [documentation][includes] - -## Version 2.2 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.2 comes with a global `includes` options to include other Taskfiles: - -```yaml -version: '2' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -## Version 2.1 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.1 includes a global `output` option, to allow having more control over how commands output are printed to the console (see [documentation][output] for more info): - -```yaml -version: '2' - -output: prefixed - -tasks: - server: - cmds: - - go run main.go - prefix: server -``` - -From this version it's also possible to ignore errors of a command or task (check documentation [here][ignore_errors]): - -```yaml -version: '2' - -tasks: - example-1: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "This will be print" - - example-2: - cmds: - - exit 1 - - echo "This will be print" - ignore_error: true -``` - -## Version 2.0 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -At version 2, we introduced the `version:` key, to allow us to evolve Task with new features without breaking existing Taskfiles. The new syntax is as follows: - -```yaml -version: '2' - -tasks: - echo: - cmds: - - echo "Hello, World!" -``` - -Version 2 allows you to write global variables directly in the Taskfile, if you don't want to create a `Taskvars.yml`: - -```yaml -version: '2' - -vars: - GREETING: Hello, World! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -The variable priority order changed to the following: - -1. Task variables -2. Call variables -3. Taskfile variables -4. Taskvars file variables -5. Environment variables - -A new global option was added to configure the number of variables expansions (which default to 2): - -```yaml -version: '2' - -expansions: 3 - -vars: - FOO: foo - BAR: bar - BAZ: baz - FOOBAR: '{{.FOO}}{{.BAR}}' - FOOBARBAZ: '{{.FOOBAR}}{{.BAZ}}' - -tasks: - default: - cmds: - - echo "{{.FOOBARBAZ}}" -``` - -## Version 1 - -:::caution - -v1 schema support was removed in Task >= v3.0.0. - -::: - -In the first version of the `Taskfile`, the `version:` key was not available, because the tasks was in the root of the YAML document. Like this: - -```yaml -echo: - cmds: - - echo "Hello, World!" -``` - -The variable priority order was also different: - -1. Call variables -2. Environment -3. Task variables -4. `Taskvars.yml` variables - - - - -[deprecate-version-2-schema]: /deprecations/version-2-schema/ -[output]: /usage#output-syntax -[ignore_errors]: /usage#ignore-errors -[includes]: /usage#including-other-taskfiles diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/translate.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/translate.md deleted file mode 100644 index 465d9628..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/translate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -slug: /translate/ -sidebar_position: 12 ---- - -# Traduza - -Quer nos ajudar a traduzir esta documentação? Neste documento, explicamos como. - -NÃO edite os arquivos markdown traduzidos diretamente no repositório do GitHub! Nós usamos o [Crowdin][crowdin] para permitir que os contribuidores trabalhem nas traduções. O repositório é atualizado periodicamente com o progresso no Crowdin. - -Se você quer ter acesso ao projeto Crowdin para ser capaz de sugerir traduções, por favor, peça acesso no canal [#translations no nosso servidor do Discord][discord]. Se um determinado idioma ainda não está sendo mostrado ao Crowdin, basta pedir e podemos configurá-lo. - - - - -[crowdin]: https://crowdin.com/project/taskfile -[discord]: https://discord.gg/6TY36E39UK diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage.md deleted file mode 100644 index eaf41ac0..00000000 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage.md +++ /dev/null @@ -1,1624 +0,0 @@ ---- -slug: /usage/ -sidebar_position: 3 ---- - -# Guia de Uso - -## Primeiros passos - -Create a file called `Taskfile.yml` in the root of your project. The `cmds` attribute should contain the commands of a task. The example below allows compiling a Go app and uses [esbuild](https://esbuild.github.io/) to concat and minify multiple CSS files into a single one. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -Running the tasks is as simple as running: - -```bash -task assets build -``` - -Task uses [mvdan.cc/sh](https://mvdan.cc/sh/), a native Go sh interpreter. So you can write sh/bash commands, and it will work even on Windows, where `sh` or `bash` are usually not available. Just remember any executable called must be available by the OS or in PATH. - -If you omit a task name, "default" will be assumed. - -## Supported file names - -Task will look for the following file names, in order of priority: - -- Taskfile.yml -- taskfile.yml -- Taskfile.yaml -- taskfile.yaml -- Taskfile.dist.yml -- taskfile.dist.yml -- Taskfile.dist.yaml -- taskfile.dist.yaml - -The intention of having the `.dist` variants is to allow projects to have one committed version (`.dist`) while still allowing individual users to override the Taskfile by adding an additional `Taskfile.yml` (which would be on `.gitignore`). - -### Running a Taskfile from a subdirectory - -If a Taskfile cannot be found in the current working directory, it will walk up the file tree until it finds one (similar to how `git` works). When running Task from a subdirectory like this, it will behave as if you ran it from the directory containing the Taskfile. - -You can use this functionality along with the special `{{.USER_WORKING_DIR}}` variable to create some very useful reusable tasks. For example, if you have a monorepo with directories for each microservice, you can `cd` into a microservice directory and run a task command to bring it up without having to create multiple tasks or Taskfiles with identical content. For example: - -```yaml -version: '3' - -tasks: - up: - dir: '{{.USER_WORKING_DIR}}' - preconditions: - - test -f docker-compose.yml - cmds: - - docker-compose up -d -``` - -In this example, we can run `cd ` and `task up` and as long as the `` directory contains a `docker-compose.yml`, the Docker composition will be brought up. - -### Running a global Taskfile - -If you call Task with the `--global` (alias `-g`) flag, it will look for your home directory instead of your working directory. In short, Task will look for a Taskfile that matches `$HOME/{T,t}askfile.{yml,yaml}` . - -This is useful to have automation that you can run from anywhere in your system! - -:::info - -When running your global Taskfile with `-g`, tasks will run on `$HOME` by default, and not on your working directory! - -As mentioned in the previous section, the `{{.USER_WORKING_DIR}}` special variable can be very handy here to run stuff on the directory you're calling `task -g` from. - -```yaml -version: '3' - -tasks: - from-home: - cmds: - - pwd - - from-working-directory: - dir: '{{.USER_WORKING_DIR}}' - cmds: - - pwd -``` - -::: - -## Environment variables - -### Task - -You can use `env` to set custom environment variables for a specific task: - -```yaml -version: '3' - -tasks: - greet: - cmds: - - echo $GREETING - env: - GREETING: Hey, there! -``` - -Additionally, you can set global environment variables that will be available to all tasks: - -```yaml -version: '3' - -env: - GREETING: Hey, there! - -tasks: - greet: - cmds: - - echo $GREETING -``` - -:::info - -`env` supports expansion and retrieving output from a shell command just like variables, as you can see in the [Variables](#variables) section. - -::: - -### .env files - -You can also ask Task to include `.env` like files by using the `dotenv:` setting: - -```bash title=".env" -KEYNAME=VALUE -``` - -```bash title="testing/.env" -ENDPOINT=testing.com -``` - -```yaml title="Taskfile.yml" -version: '3' - -env: - ENV: testing - -dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - -tasks: - greet: - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Dotenv files can also be specified at the task level: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Environment variables specified explicitly at the task-level will override variables defined in dotfiles: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - env: - KEYNAME: DIFFERENT_VALUE - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -:::info - -Please note that you are not currently able to use the `dotenv` key inside included Taskfiles. - -::: - -## Including other Taskfiles - -If you want to share tasks between different projects (Taskfiles), you can use the importing mechanism to include other Taskfiles using the `includes` keyword: - -```yaml -version: '3' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -The tasks described in the given Taskfiles will be available with the informed namespace. So, you'd call `task docs:serve` to run the `serve` task from `documentation/Taskfile.yml` or `task docker:build` to run the `build` task from the `DockerTasks.yml` file. - -Relative paths are resolved relative to the directory containing the including Taskfile. - -### OS-specific Taskfiles - -With `version: '2'`, task automatically includes any `Taskfile_{{OS}}.yml` if it exists (for example: `Taskfile_windows.yml`, `Taskfile_linux.yml` or `Taskfile_darwin.yml`). Since this behavior was a bit too implicit, it was removed on version 3, but you still can have a similar behavior by explicitly importing these files: - -```yaml -version: '3' - -includes: - build: ./Taskfile_{{OS}}.yml -``` - -### Directory of included Taskfile - -By default, included Taskfile's tasks are run in the current directory, even if the Taskfile is in another directory, but you can force its tasks to run in another directory by using this alternative syntax: - -```yaml -version: '3' - -includes: - docs: - taskfile: ./docs/Taskfile.yml - dir: ./docs -``` - -:::info - -The included Taskfiles must be using the same schema version as the main Taskfile uses. - -::: - -### Optional includes - -Includes marked as optional will allow Task to continue execution as normal if the included file is missing. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./tests/Taskfile.yml - optional: true - -tasks: - greet: - cmds: - - echo "This command can still be successfully executed if - ./tests/Taskfile.yml does not exist" -``` - -### Internal includes - -Includes marked as internal will set all the tasks of the included file to be internal as well (see the [Internal tasks](#internal-tasks) section below). This is useful when including utility tasks that are not intended to be used directly by the user. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./taskfiles/Utils.yml - internal: true -``` - -### Vars of included Taskfiles - -You can also specify variables when including a Taskfile. This may be useful for having reusable Taskfile that can be tweaked or even included more than once: - -```yaml -version: '3' - -includes: - backend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: backend_image - - frontend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: frontend_image -``` - -### Namespace aliases - -When including a Taskfile, you can give the namespace a list of `aliases`. This works in the same way as [task aliases](#task-aliases) and can be used together to create shorter and easier-to-type commands. - -```yaml -version: '3' - -includes: - generate: - taskfile: ./taskfiles/Generate.yml - aliases: [gen] -``` - -:::info - -Vars declared in the included Taskfile have preference over the variables in the including Taskfile! If you want a variable in an included Taskfile to be overridable, use the [default function](https://go-task.github.io/slim-sprig/defaults.html): `MY_VAR: '{{.MY_VAR | default "my-default-value"}}'`. - -::: - -## Internal tasks - -Internal tasks are tasks that cannot be called directly by the user. They will not appear in the output when running `task --list|--list-all`. Other tasks may call internal tasks in the usual way. This is useful for creating reusable, function-like tasks that have no useful purpose on the command line. - -```yaml -version: '3' - -tasks: - build-image-1: - cmds: - - task: build-image - vars: - DOCKER_IMAGE: image-1 - - build-image: - internal: true - cmds: - - docker build -t {{.DOCKER_IMAGE}} . -``` - -## Task directory - -By default, tasks will be executed in the directory where the Taskfile is located. But you can easily make the task run in another folder, informing `dir`: - -```yaml -version: '3' - -tasks: - serve: - dir: public/www - cmds: - # run http server - - caddy -``` - -If the directory does not exist, `task` creates it. - -## Task dependencies - -> Dependencies run in parallel, so dependencies of a task should not depend one another. If you want to force tasks to run serially, take a look at the [Calling Another Task](#calling-another-task) section below. - -You may have tasks that depend on others. Just pointing them on `deps` will make them run automatically before running the parent task: - -```yaml -version: '3' - -tasks: - build: - deps: [assets] - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -In the above example, `assets` will always run right before `build` if you run `task build`. - -A task can have only dependencies and no commands to group tasks together: - -```yaml -version: '3' - -tasks: - assets: - deps: [js, css] - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -If there is more than one dependency, they always run in parallel for better performance. - -:::tip - -You can also make the tasks given by the command line run in parallel by using the `--parallel` flag (alias `-p`). Example: `task --parallel js css`. - -::: - -If you want to pass information to dependencies, you can do that the same manner as you would to [call another task](#calling-another-task): - -```yaml -version: '3' - -tasks: - default: - deps: - - task: echo_sth - vars: { TEXT: 'before 1' } - - task: echo_sth - vars: { TEXT: 'before 2' } - silent: true - cmds: - - echo "after" - - echo_sth: - cmds: - - echo {{.TEXT}} -``` - -## Platform specific tasks and commands - -If you want to restrict the running of tasks to explicit platforms, this can be achieved using the `platforms:` key. Tasks can be restricted to a specific OS, architecture or a combination of both. On a mismatch, the task or command will be skipped, and no error will be thrown. - -The values allowed as OS or Arch are valid `GOOS` and `GOARCH` values, as defined by the Go language [here](https://github.com/golang/go/blob/master/src/go/build/syslist.go). - -The `build-windows` task below will run only on Windows, and on any architecture: - -```yaml -version: '3' - -tasks: - build-windows: - platforms: [windows] - cmds: - - echo 'Running command on Windows' -``` - -This can be restricted to a specific architecture as follows: - -```yaml -version: '3' - -tasks: - build-windows-amd64: - platforms: [windows/amd64] - cmds: - - echo 'Running command on Windows (amd64)' -``` - -It is also possible to restrict the task to specific architectures: - -```yaml -version: '3' - -tasks: - build-amd64: - platforms: [amd64] - cmds: - - echo 'Running command on amd64' -``` - -Multiple platforms can be specified as follows: - -```yaml -version: '3' - -tasks: - build: - platforms: [windows/amd64, darwin] - cmds: - - echo 'Running command on Windows (amd64) and macOS' -``` - -Individual commands can also be restricted to specific platforms: - -```yaml -version: '3' - -tasks: - build: - cmds: - - cmd: echo 'Running command on Windows (amd64) and macOS' - platforms: [windows/amd64, darwin] - - cmd: echo 'Running on all platforms' -``` - -## Calling another task - -When a task has many dependencies, they are executed concurrently. This will often result in a faster build pipeline. However, in some situations, you may need to call other tasks serially. In this case, use the following syntax: - -```yaml -version: '3' - -tasks: - main-task: - cmds: - - task: task-to-be-called - - task: another-task - - echo "Both done" - - task-to-be-called: - cmds: - - echo "Task to be called" - - another-task: - cmds: - - echo "Another task" -``` - -Using the `vars` and `silent` attributes you can choose to pass variables and toggle [silent mode](#silent-mode) on a call-by-call basis: - -```yaml -version: '3' - -tasks: - greet: - vars: - RECIPIENT: '{{default "World" .RECIPIENT}}' - cmds: - - echo "Hello, {{.RECIPIENT}}!" - - greet-pessimistically: - cmds: - - task: greet - vars: { RECIPIENT: 'Cruel World' } - silent: true -``` - -The above syntax is also supported in `deps`. - -:::tip - -NOTE: If you want to call a task declared in the root Taskfile from within an [included Taskfile](#including-other-taskfiles), add a leading `:` like this: `task: :task-name`. - -::: - -## Prevent unnecessary work - -### By fingerprinting locally generated files and their sources - -If a task generates something, you can inform Task the source and generated files, so Task will prevent running them if not necessary. - -```yaml -version: '3' - -tasks: - build: - deps: [js, css] - cmds: - - go build -v -i main.go - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - sources: - - src/js/**/*.js - generates: - - public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css - sources: - - src/css/**/*.css - generates: - - public/bundle.css -``` - -`sources` and `generates` can be files or glob patterns. When given, Task will compare the checksum of the source files to determine if it's necessary to run the task. If not, it will just print a message like `Task "js" is up to date`. - -`exclude:` can also be used to exclude files from fingerprinting. Sources are evaluated in order, so `exclude:` must come after the positive glob it is negating. - -```yaml -version: '3' - -tasks: - css: - sources: - - mysources/**/*.css - - exclude: mysources/ignoreme.css - generates: - - public/bundle.css -``` - -If you prefer these check to be made by the modification timestamp of the files, instead of its checksum (content), just set the `method` property to `timestamp`. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build . - sources: - - ./*.go - generates: - - app{{exeExt}} - method: timestamp -``` - -In situations where you need more flexibility the `status` keyword can be used. You can even combine the two. See the documentation for [status](#using-programmatic-checks-to-indicate-a-task-is-up-to-date) for an example. - -:::info - -By default, task stores checksums on a local `.task` directory in the project's directory. Most of the time, you'll want to have this directory on `.gitignore` (or equivalent) so it isn't committed. (If you have a task for code generation that is committed it may make sense to commit the checksum of that task as well, though). - -If you want these files to be stored in another directory, you can set a `TASK_TEMP_DIR` environment variable in your machine. It can contain a relative path like `tmp/task` that will be interpreted as relative to the project directory, or an absolute or home path like `/tmp/.task` or `~/.task` (subdirectories will be created for each project). - -```bash -export TASK_TEMP_DIR='~/.task' -``` - -::: - -:::info - -Each task has only one checksum stored for its `sources`. If you want to distinguish a task by any of its input variables, you can add those variables as part of the task's label, and it will be considered a different task. - -This is useful if you want to run a task once for each distinct set of inputs until the sources actually change. For example, if the sources depend on the value of a variable, or you if you want the task to rerun if some arguments change even if the source has not. - -::: - -:::tip - -The method `none` skips any validation and always run the task. - -::: - -:::info - -For the `checksum` (default) or `timestamp` method to work, it is only necessary to inform the source files. When the `timestamp` method is used, the last time of the running the task is considered as a generate. - -::: - -### Using programmatic checks to indicate a task is up to date - -Alternatively, you can inform a sequence of tests as `status`. If no error is returned (exit status 0), the task is considered up-to-date: - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - status: - - test -d directory - - test -f directory/file1.txt - - test -f directory/file2.txt -``` - -Normally, you would use `sources` in combination with `generates` - but for tasks that generate remote artifacts (Docker images, deploys, CD releases) the checksum source and timestamps require either access to the artifact or for an out-of-band refresh of the `.checksum` fingerprint file. - -Two special variables `{{.CHECKSUM}}` and `{{.TIMESTAMP}}` are available for interpolation within `status` commands, depending on the method assigned to fingerprint the sources. Only `source` globs are fingerprinted. - -Note that the `{{.TIMESTAMP}}` variable is a "live" Go `time.Time` struct, and can be formatted using any of the methods that `time.Time` responds to. - -See [the Go Time documentation](https://golang.org/pkg/time/) for more information. - -You can use `--force` or `-f` if you want to force a task to run even when up-to-date. - -Also, `task --status [tasks]...` will exit with a non-zero exit code if any of the tasks are not up-to-date. - -`status` can be combined with the [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) to have a task run if either the the source/generated artifacts changes, or the programmatic check fails: - -```yaml -version: '3' - -tasks: - build:prod: - desc: Build for production usage. - cmds: - - composer install - # Run this task if source files changes. - sources: - - composer.json - - composer.lock - generates: - - ./vendor/composer/installed.json - - ./vendor/autoload.php - # But also run the task if the last build was not a production build. - status: - - grep -q '"dev": false' ./vendor/composer/installed.json -``` - -### Using programmatic checks to cancel the execution of a task and its dependencies - -In addition to `status` checks, `preconditions` checks are the logical inverse of `status` checks. That is, if you need a certain set of conditions to be _true_ you can use the `preconditions` stanza. `preconditions` are similar to `status` lines, except they support `sh` expansion, and they SHOULD all return 0. - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - preconditions: - - test -f .env - - sh: '[ 1 = 0 ]' - msg: "One doesn't equal Zero, Halting" -``` - -Preconditions can set specific failure messages that can tell a user what steps to take using the `msg` field. - -If a task has a dependency on a sub-task with a precondition, and that precondition is not met - the calling task will fail. Note that a task executed with a failing precondition will not run unless `--force` is given. - -Unlike `status`, which will skip a task if it is up to date and continue executing tasks that depend on it, a `precondition` will fail a task, along with any other tasks that depend on it. - -```yaml -version: '3' - -tasks: - task-will-fail: - preconditions: - - sh: 'exit 1' - - task-will-also-fail: - deps: - - task-will-fail - - task-will-still-fail: - cmds: - - task: task-will-fail - - echo "I will not run" -``` - -### Limiting when tasks run - -If a task executed by multiple `cmds` or multiple `deps` you can control when it is executed using `run`. `run` can also be set at the root of the Taskfile to change the behavior of all the tasks unless explicitly overridden. - -Supported values for `run`: - -- `always` (default) always attempt to invoke the task regardless of the number of previous executions -- `once` only invoke this task once regardless of the number of references -- `when_changed` only invokes the task once for each unique set of variables passed into the task - -```yaml -version: '3' - -tasks: - default: - cmds: - - task: generate-file - vars: { CONTENT: '1' } - - task: generate-file - vars: { CONTENT: '2' } - - task: generate-file - vars: { CONTENT: '2' } - - generate-file: - run: when_changed - deps: - - install-deps - cmds: - - echo {{.CONTENT}} - - install-deps: - run: once - cmds: - - sleep 5 # long operation like installing packages -``` - -### Ensuring required variables are set - -If you want to check that certain variables are set before running a task then you can use `requires`. This is useful when might not be clear to users which variables are needed, or if you want clear message about what is required. Also some tasks could have dangerous side effects if run with un-set variables. - -Using `requires` you specify an array of strings in the `vars` sub-section under `requires`, these strings are variable names which are checked prior to running the task. If any variables are un-set the the task will error and not run. - -Environmental variables are also checked. - -Syntax: - -```yaml -requires: - vars: [] # Array of strings -``` - -:::note - -Variables set to empty zero length strings, will pass the `requires` check. - -::: - -Example of using `requires`: - -```yaml -version: '3' - -tasks: - docker-build: - cmds: - - 'docker build . -t {{.IMAGE_NAME}}:{{.IMAGE_TAG}}' - - # Make sure these variables are set before running - requires: - vars: [IMAGE_NAME, IMAGE_TAG] -``` - -## Variables - -When doing interpolation of variables, Task will look for the below. They are listed below in order of importance (i.e. most important first): - -- Variables declared in the task definition -- Variables given while calling a task from another (See [Calling another task](#calling-another-task) above) -- Variables of the [included Taskfile](#including-other-taskfiles) (when the task is included) -- Variables of the [inclusion of the Taskfile](#vars-of-included-taskfiles) (when the task is included) -- Global variables (those declared in the `vars:` option in the Taskfile) -- Environment variables - -Example of sending parameters with environment variables: - -```bash -$ TASK_VARIABLE=a-value task do-something -``` - -:::tip - -A special variable `.TASK` is always available containing the task name. - -::: - -Since some shells do not support the above syntax to set environment variables (Windows) tasks also accept a similar style when not at the beginning of the command. - -```bash -$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!" -``` - -Example of locally declared vars: - -```yaml -version: '3' - -tasks: - print-var: - cmds: - - echo "{{.VAR}}" - vars: - VAR: Hello! -``` - -Example of global vars in a `Taskfile.yml`: - -```yaml -version: '3' - -vars: - GREETING: Hello from Taskfile! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -### Dynamic variables - -The below syntax (`sh:` prop in a variable) is considered a dynamic variable. The value will be treated as a command and the output assigned. If there are one or more trailing newlines, the last newline will be trimmed. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go - vars: - GIT_COMMIT: - sh: git log -n 1 --format=%h -``` - -This works for all types of variables. - -## Looping over values - -As of v3.28.0, Task allows you to loop over certain values and execute a command for each. There are a number of ways to do this depending on the type of value you want to loop over. - -### Looping over a static list - -The simplest kind of loop is an explicit one. This is useful when you want to loop over a set of values that are known ahead of time. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: ['foo.txt', 'bar.txt'] - cmd: cat {{ .ITEM }} -``` - -### Looping over your task's sources - -You are also able to loop over the sources of your task: - -```yaml -version: '3' - -tasks: - default: - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{ .ITEM }} -``` - -This will also work if you use globbing syntax in your sources. For example, if you specify a source for `*.txt`, the loop will iterate over all files that match that glob. - -Source paths will always be returned as paths relative to the task directory. If you need to convert this to an absolute path, you can use the built-in `joinPath` function. There are some [special variables](/api/#special-variables) that you may find useful for this. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_DIR: /path/to/dir - dir: '{{.MY_DIR}}' - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{joinPath .MY_DIR .ITEM}} -``` - -### Looping over variables - -To loop over the contents of a variable, you simply need to specify the variable you want to loop over. By default, variables will be split on any whitespace characters. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -If you need to split on a different character, you can do this by specifying the `split` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt,bar.txt - cmds: - - for: { var: MY_VAR, split: ',' } - cmd: cat {{.ITEM}} -``` - -All of this also works with dynamic variables! - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: - sh: find -type f -name '*.txt' - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -### Renaming variables - -If you want to rename the iterator variable to make it clearer what the value contains, you can do so by specifying the `as` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR, as: FILE } - cmd: cat {{.FILE}} -``` - -### Looping over tasks - -Because the `for` property is defined at the `cmds` level, you can also use it alongside the `task` keyword to run tasks multiple times with different variables. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: my-task - vars: - FILE: '{{.ITEM}}' - - my-task: - cmds: - - echo '{{.FILE}}' -``` - -Or if you want to run different tasks depending on the value of the loop: - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: task-{{.ITEM}} - - task-foo: - cmds: - - echo 'foo' - - task-bar: - cmds: - - echo 'bar' -``` - -## Forwarding CLI arguments to commands - -If `--` is given in the CLI, all following parameters are added to a special `.CLI_ARGS` variable. This is useful to forward arguments to another command. - -The below example will run `yarn install`. - -```bash -$ task yarn -- install -``` - -```yaml -version: '3' - -tasks: - yarn: - cmds: - - yarn {{.CLI_ARGS}} -``` - -## Doing task cleanup with `defer` - -With the `defer` keyword, it's possible to schedule cleanup to be run once the task finishes. The difference with just putting it as the last command is that this command will run even when the task fails. - -In the example below, `rm -rf tmpdir/` will run even if the third command fails: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: rm -rf tmpdir/ - - echo 'Do work on tmpdir/' -``` - -If you want to move the cleanup command into another task, that is possible as well: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: { task: cleanup } - - echo 'Do work on tmpdir/' - - cleanup: rm -rf tmpdir/ -``` - -:::info - -Due to the nature of how the [Go's own `defer` work](https://go.dev/tour/flowcontrol/13), the deferred commands are executed in the reverse order if you schedule multiple of them. - -::: - -## Go's template engine - -Task parse commands as [Go's template engine][gotemplate] before executing them. Variables are accessible through dot syntax (`.VARNAME`). - -All functions by the Go's [slim-sprig lib](https://go-task.github.io/slim-sprig/) are available. The following example gets the current date in a given format: - -```yaml -version: '3' - -tasks: - print-date: - cmds: - - echo {{now | date "2006-01-02"}} -``` - -Task also adds the following functions: - -- `OS`: Returns the operating system. Possible values are `windows`, `linux`, `darwin` (macOS) and `freebsd`. -- `ARCH`: return the architecture Task was compiled to: `386`, `amd64`, `arm` or `s390x`. -- `splitLines`: Splits Unix (`\n`) and Windows (`\r\n`) styled newlines. -- `catLines`: Replaces Unix (`\n`) and Windows (`\r\n`) styled newlines with a space. -- `toSlash`: Does nothing on Unix, but on Windows converts a string from `\` path format to `/`. -- `fromSlash`: Opposite of `toSlash`. Does nothing on Unix, but on Windows converts a string from `/` path format to `\`. -- `exeExt`: Returns the right executable extension for the current OS (`".exe"` for Windows, `""` for others). -- `shellQuote`: Quotes a string to make it safe for use in shell scripts. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote) for this. The Bash dialect is assumed. -- `splitArgs`: Splits a string as if it were a command's arguments. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/shell#Fields) - -Example: - -```yaml -version: '3' - -tasks: - print-os: - cmds: - - echo '{{OS}} {{ARCH}}' - - echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}' - # This will be path/to/file on Unix but path\to\file on Windows - - echo '{{fromSlash "path/to/file"}}' - enumerated-file: - vars: - CONTENT: | - foo - bar - cmds: - - | - cat << EOF > output.txt - {{range $i, $line := .CONTENT | splitLines -}} - {{printf "%3d" $i}}: {{$line}} - {{end}}EOF -``` - -## Help - -Running `task --list` (or `task -l`) lists all tasks with a description. The following Taskfile: - -```yaml -version: '3' - -tasks: - build: - desc: Build the go binary. - cmds: - - go build -v -i main.go - - test: - desc: Run all the go tests. - cmds: - - go test -race ./... - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -would print the following output: - -```bash -* build: Build the go binary. -* test: Run all the go tests. -``` - -If you want to see all tasks, there's a `--list-all` (alias `-a`) flag as well. - -## Display summary of task - -Running `task --summary task-name` will show a summary of a task. The following Taskfile: - -```yaml -version: '3' - -tasks: - release: - deps: [build] - summary: | - Release your project to github - - It will build your project before starting the release. - Please make sure that you have set GITHUB_TOKEN before starting. - cmds: - - your-release-tool - - build: - cmds: - - your-build-tool -``` - -with running `task --summary release` would print the following output: - -``` -task: release - -Release your project to github - -It will build your project before starting the release. -Please make sure that you have set GITHUB_TOKEN before starting. - -dependencies: - - build - -commands: - - your-release-tool -``` - -If a summary is missing, the description will be printed. If the task does not have a summary or a description, a warning is printed. - -Please note: _showing the summary will not execute the command_. - -## Task aliases - -Aliases are alternative names for tasks. They can be used to make it easier and quicker to run tasks with long or hard-to-type names. You can use them on the command line, when [calling sub-tasks](#calling-another-task) in your Taskfile and when [including tasks](#including-other-taskfiles) with aliases from another Taskfile. They can also be used together with [namespace aliases](#namespace-aliases). - -```yaml -version: '3' - -tasks: - generate: - aliases: [gen] - cmds: - - task: gen-mocks - - generate-mocks: - aliases: [gen-mocks] - cmds: - - echo "generating..." -``` - -## Overriding task name - -Sometimes you may want to override the task name printed on the summary, up-to-date messages to STDOUT, etc. In this case, you can just set `label:`, which can also be interpolated with variables: - -```yaml -version: '3' - -tasks: - default: - - task: print - vars: - MESSAGE: hello - - task: print - vars: - MESSAGE: world - - print: - label: 'print-{{.MESSAGE}}' - cmds: - - echo "{{.MESSAGE}}" -``` - -## Warning Prompts - -Warning Prompts are used to prompt a user for confirmation before a task is executed. - -Below is an example using `prompt` with a dangerous command, that is called between two safe commands: - -```yaml -version: '3' - -tasks: - example: - cmds: - - task: not-dangerous - - task: dangerous - - task: another-not-dangerous - - not-dangerous: - cmds: - - echo 'not dangerous command' - - another-not-dangerous: - cmds: - - echo 'another not dangerous command' - - dangerous: - prompt: This is a dangerous command... Do you want to continue? - cmds: - - echo 'dangerous command' -``` - -```bash -❯ task dangerous -task: "This is a dangerous command... Do you want to continue?" [y/N] -``` - -Warning prompts are called before executing a task. If a prompt is denied Task will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue as normal. - -```bash -❯ task example -not dangerous command -task: "This is a dangerous command. Do you want to continue?" [y/N] -y -dangerous command -another not dangerous command -``` - -To skip warning prompts automatically, you can use the `--yes` (alias `-y`) option when calling the task. By including this option, all warnings, will be automatically confirmed, and no prompts will be shown. - -:::caution - -Tasks with prompts always fail by default on non-terminal environments, like a CI, where an `stdin` won't be available for the user to answer. In those cases, use `--yes` (`-y`) to force all tasks with a prompt to run. - -::: - -## Silent mode - -Silent mode disables the echoing of commands before Task runs it. For the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" -``` - -Normally this will be printed: - -```sh -echo "Print something" -Print something -``` - -With silent mode on, the below will be printed instead: - -```sh -Print something -``` - -There are four ways to enable silent mode: - -- At command level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: echo "Print something" - silent: true -``` - -- At task level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" - silent: true -``` - -- Globally at Taskfile level: - -```yaml -version: '3' - -silent: true - -tasks: - echo: - cmds: - - echo "Print something" -``` - -- Or globally with `--silent` or `-s` flag - -If you want to suppress STDOUT instead, just redirect a command to `/dev/null`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "This will print nothing" > /dev/null -``` - -## Dry run mode - -Dry run mode (`--dry`) compiles and steps through each task, printing the commands that would be run without executing them. This is useful for debugging your Taskfiles. - -## Ignore errors - -You have the option to ignore errors during command execution. Given the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - exit 1 - - echo "Hello World" -``` - -Task will abort the execution after running `exit 1` because the status code `1` stands for `EXIT_FAILURE`. However, it is possible to continue with execution using `ignore_error`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "Hello World" -``` - -`ignore_error` can also be set for a task, which means errors will be suppressed for all commands. Nevertheless, keep in mind that this option will not propagate to other tasks called either by `deps` or `cmds`! - -## Output syntax - -By default, Task just redirects the STDOUT and STDERR of the running commands to the shell in real-time. This is good for having live feedback for logging printed by commands, but the output can become messy if you have multiple commands running simultaneously and printing lots of stuff. - -To make this more customizable, there are currently three different output options you can choose: - -- `interleaved` (default) -- `group` -- `prefixed` - -To choose another one, just set it to root in the Taskfile: - -```yaml -version: '3' - -output: 'group' - -tasks: - # ... -``` - -The `group` output will print the entire output of a command once after it finishes, so you will not have live feedback for commands that take a long time to run. - -When using the `group` output, you can optionally provide a templated message to print at the start and end of the group. This can be useful for instructing CI systems to group all of the output for a given task, such as with [GitHub Actions' `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) or [Azure Pipelines](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?expand=1&view=azure-devops&tabs=bash#formatting-commands). - -```yaml -version: '3' - -output: - group: - begin: '::group::{{.TASK}}' - end: '::endgroup::' - -tasks: - default: - cmds: - - echo 'Hello, World!' - silent: true -``` - -```bash -$ task default -::group::default -Hello, World! -::endgroup:: -``` - -When using the `group` output, you may swallow the output of the executed command on standard output and standard error if it does not fail (zero exit code). - -```yaml -version: '3' - -silent: true - -output: - group: - error_only: true - -tasks: - passes: echo 'output-of-passes' - errors: echo 'output-of-errors' && exit 1 -``` - -```bash -$ task passes -$ task errors -output-of-errors -task: Failed to run task "errors": exit status 1 -``` - -The `prefix` output will prefix every line printed by a command with `[task-name]` as the prefix, but you can customize the prefix for a command with the `prefix:` attribute: - -```yaml -version: '3' - -output: prefixed - -tasks: - default: - deps: - - task: print - vars: { TEXT: foo } - - task: print - vars: { TEXT: bar } - - task: print - vars: { TEXT: baz } - - print: - cmds: - - echo "{{.TEXT}}" - prefix: 'print-{{.TEXT}}' - silent: true -``` - -```bash -$ task default -[print-foo] foo -[print-bar] bar -[print-baz] baz -``` - -:::tip - -The `output` option can also be specified by the `--output` or `-o` flags. - -::: - -## Interactive CLI application - -When running interactive CLI applications inside Task they can sometimes behave weirdly, especially when the [output mode](#output-syntax) is set to something other than `interleaved` (the default), or when interactive apps are run in parallel with other tasks. - -The `interactive: true` tells Task this is an interactive application and Task will try to optimize for it: - -```yaml -version: '3' - -tasks: - default: - cmds: - - vim my-file.txt - interactive: true -``` - -If you still have problems running an interactive app through Task, please open an issue about it. - -## Short task syntax - -Starting on Task v3, you can now write tasks with a shorter syntax if they have the default settings (e.g. no custom `env:`, `vars:`, `desc:`, `silent:` , etc): - -```yaml -version: '3' - -tasks: - build: go build -v -o ./app{{exeExt}} . - - run: - - task: build - - ./app{{exeExt}} -h localhost -p 8080 -``` - -## `set` and `shopt` - -It's possible to specify options to the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins. This can be added at global, task or command level. - -```yaml -version: '3' - -set: [pipefail] -shopt: [globstar] - -tasks: - # `globstar` required for double star globs to work - default: echo **/*.go -``` - -:::info - -Keep in mind that not all options are available in the [shell interpreter library](https://github.com/mvdan/sh) that Task uses. - -::: - -## Watch tasks - -With the flags `--watch` or `-w` task will watch for file changes and run the task again. This requires the `sources` attribute to be given, so task knows which files to watch. - -The default watch interval is 5 seconds, but it's possible to change it by either setting `interval: '500ms'` in the root of the Taskfile passing it as an argument like `--interval=500ms`. - -Also, it's possible to set `watch: true` in a given task and it'll automatically run in watch mode: - -```yaml -version: '3' - -interval: 500ms - -tasks: - build: - desc: Builds the Go application - watch: true - sources: - - '**/*.go' - cmds: - - go build # ... -``` - -:::info - -Note that when setting `watch: true` to a task, it'll only run in watch mode when running from the CLI via `task my-watch-task`, but won't run in watch mode if called by another task, either directly or as a dependency. - -::: - - - - -[gotemplate]: https://golang.org/pkg/text/template/ diff --git a/docs/i18n/pt-BR/docusaurus-theme-classic/footer.json b/docs/i18n/pt-BR/docusaurus-theme-classic/footer.json deleted file mode 100644 index 6a3d8ada..00000000 --- a/docs/i18n/pt-BR/docusaurus-theme-classic/footer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "link.title.Pages": { - "message": "Páginas", - "description": "The title of the footer links column with title=Pages in the footer" - }, - "link.title.Community": { - "message": "Comunidade", - "description": "The title of the footer links column with title=Community in the footer" - }, - "link.title.Translations": { - "message": "Traduções", - "description": "The title of the footer links column with title=Translations in the footer" - }, - "link.item.label.Installation": { - "message": "Instalação", - "description": "The label of footer link with label=Installation linking to /installation/" - }, - "link.item.label.Usage": { - "message": "Guia de Uso", - "description": "The label of footer link with label=Usage linking to /usage/" - }, - "link.item.label.Donate": { - "message": "Doe", - "description": "The label of footer link with label=Donate linking to /donate/" - }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/go-task/task" - }, - "link.item.label.Twitter": { - "message": "Twitter", - "description": "The label of footer link with label=Twitter linking to https://twitter.com/taskfiledev" - }, - "link.item.label.Mastodon": { - "message": "Mastodon", - "description": "The label of footer link with label=Mastodon linking to https://fosstodon.org/@task" - }, - "link.item.label.Discord": { - "message": "Discord", - "description": "The label of footer link with label=Discord linking to https://discord.gg/6TY36E39UK" - }, - "link.item.label.OpenCollective": { - "message": "OpenCollective", - "description": "The label of footer link with label=OpenCollective linking to https://opencollective.com/task" - } -} diff --git a/docs/i18n/pt-BR/docusaurus-theme-classic/navbar.json b/docs/i18n/pt-BR/docusaurus-theme-classic/navbar.json deleted file mode 100644 index d49276d5..00000000 --- a/docs/i18n/pt-BR/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "title": { - "message": "Task", - "description": "The title in the navbar" - }, - "item.label.Installation": { - "message": "Instalação", - "description": "Navbar item with label Installation" - }, - "item.label.Usage": { - "message": "Guia de Uso", - "description": "Navbar item with label Usage" - }, - "item.label.API": { - "message": "API", - "description": "Navbar item with label API" - }, - "item.label.Donate": { - "message": "Doe", - "description": "Navbar item with label Donate" - }, - "item.label.GitHub": { - "message": "GitHub", - "description": "Navbar item with label GitHub" - }, - "item.label.Twitter": { - "message": "Twitter", - "description": "Navbar item with label Twitter" - }, - "item.label.Mastodon": { - "message": "Mastodon", - "description": "Navbar item with label Mastodon" - }, - "item.label.Discord": { - "message": "Discord", - "description": "Navbar item with label Discord" - } -} diff --git a/docs/i18n/ru-RU/code.json b/docs/i18n/ru-RU/code.json deleted file mode 100644 index 2e4e2f74..00000000 --- a/docs/i18n/ru-RU/code.json +++ /dev/null @@ -1,396 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "На странице произошёл сбой.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Попробуйте ещё раз", - "description": "The label of the button to try again when the page crashed" - }, - "theme.NotFound.title": { - "message": "Страница не найдена", - "description": "The title of the 404 page" - }, - "theme.NotFound.p1": { - "message": "К сожалению, мы не смогли найти запрашиваемую вами страницу.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Пожалуйста, обратитесь к владельцу сайта, с которого вы перешли на эту ссылку, чтобы сообщить ему, что ссылка не работает.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.admonition.note": { - "message": "примечание", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "подсказка", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.danger": { - "message": "осторожно", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "к сведению", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.caution": { - "message": "предупреждение", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Прокрутка к началу", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "Архив", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Архив", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Навигация по странице списка блогов", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Следующие записи", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Предыдущие записи", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Навигация по странице поста блога", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Следующий пост", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Предыдущий пост", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "{count} запись|{count} записи|{count} записей", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} с тегом \"{tagName}\"", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "Посмотреть все теги", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Переключение между темным и светлым режимом (сейчас используется {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "Тёмный режим", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "Светлый режим", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.home": { - "message": "Главная страница", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Навигационная цепочка текущей страницы", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} элемент|{count} элемента|{count} элементов", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Навигация по странице документации", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Предыдущая страница", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Следующая страница", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "Одна страница|{count} страницы|{count} страниц", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} с тегом \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Версия: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "Это документация для будущей версии {siteTitle} {versionLabel}.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "Это документация {siteTitle} для версии {versionLabel}, которая уже не поддерживается.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "Актуальная документация находится на странице {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "последней версии", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Отредактировать эту страницу", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Прямая ссылка на {heading}", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " от {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Последнее обновление{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Версии", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Теги:", - "description": "The label alongside a tag list" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Закрыть", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Навигация по последним постам в блоге", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Скопировано", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Скопировать в буфер обмена", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "Скопировать", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Переключить перенос по строкам", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "Свернуть/развернуть категорию '{label}'", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Языки", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "Содержание этой страницы", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "Читать дальше", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "Подробнее о {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "{readingTime} мин. чтения", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Свернуть сайдбар", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Свернуть сайдбар", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Закрыть панель навигации", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← Перейти к главному меню", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Переключить навигационную панель", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Развернуть сайдбар", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Развернуть сайдбар", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.seeAll": { - "message": "Посмотреть все результаты ({count})" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "{count} документ|{count} документа|{count} документов", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Результаты поиска по запросу \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Поиск по сайту", - "description": "The search page title for empty query" - }, - "theme.SearchPage.inputPlaceholder": { - "message": "Введите фразу для поиска", - "description": "The placeholder for search page input" - }, - "theme.SearchPage.inputLabel": { - "message": "Поиск", - "description": "The ARIA label for search page input" - }, - "theme.SearchPage.algoliaLabel": { - "message": "Поиск от Algolia", - "description": "The ARIA label for Algolia mention" - }, - "theme.SearchPage.noResultsText": { - "message": "По запросу ничего не найдено", - "description": "The paragraph for empty search result" - }, - "theme.SearchPage.fetchingNewResults": { - "message": "Загрузка новых результатов поиска...", - "description": "The paragraph for fetching new search results" - }, - "theme.SearchBar.label": { - "message": "Поиск", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchModal.searchBox.resetButtonTitle": { - "message": "Очистить", - "description": "The label and ARIA label for search box reset button" - }, - "theme.SearchModal.searchBox.cancelButtonText": { - "message": "Отменить", - "description": "The label and ARIA label for search box cancel button" - }, - "theme.SearchModal.startScreen.recentSearchesTitle": { - "message": "Недавнее", - "description": "The title for recent searches" - }, - "theme.SearchModal.startScreen.noRecentSearchesText": { - "message": "Нет истории поиска", - "description": "The text when no recent searches" - }, - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { - "message": "Сохранить поисковый запрос", - "description": "The label for save recent search button" - }, - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { - "message": "Удалить запись из историю", - "description": "The label for remove recent search button" - }, - "theme.SearchModal.startScreen.favoriteSearchesTitle": { - "message": "Избранное", - "description": "The title for favorite searches" - }, - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { - "message": "Удалить запись из избранное", - "description": "The label for remove favorite search button" - }, - "theme.SearchModal.errorScreen.titleText": { - "message": "Невозможно загрузить результаты поиска", - "description": "The title for error screen of search modal" - }, - "theme.SearchModal.errorScreen.helpText": { - "message": "Проверьте подключение к интернету.", - "description": "The help text for error screen of search modal" - }, - "theme.SearchModal.footer.selectText": { - "message": "выбрать", - "description": "The explanatory text of the action for the enter key" - }, - "theme.SearchModal.footer.selectKeyAriaLabel": { - "message": "Клавиша Enter", - "description": "The ARIA label for the Enter key button that makes the selection" - }, - "theme.SearchModal.footer.navigateText": { - "message": "навигация", - "description": "The explanatory text of the action for the Arrow up and Arrow down key" - }, - "theme.SearchModal.footer.navigateUpKeyAriaLabel": { - "message": "Клавиша стрелка вверх", - "description": "The ARIA label for the Arrow up key button that makes the navigation" - }, - "theme.SearchModal.footer.navigateDownKeyAriaLabel": { - "message": "Клавиша стрелка вниз", - "description": "The ARIA label for the Arrow down key button that makes the navigation" - }, - "theme.SearchModal.footer.closeText": { - "message": "закрыть", - "description": "The explanatory text of the action for Escape key" - }, - "theme.SearchModal.footer.closeKeyAriaLabel": { - "message": "Клавиша Escape", - "description": "The ARIA label for the Escape key button that close the modal" - }, - "theme.SearchModal.footer.searchByText": { - "message": "Поиск от", - "description": "The text explain that the search is making by Algolia" - }, - "theme.SearchModal.noResultsScreen.noResultsText": { - "message": "Нет результатов по запросу", - "description": "The text explains that there are no results for the following search" - }, - "theme.SearchModal.noResultsScreen.suggestedQueryText": { - "message": "Попробуйте", - "description": "The text for the suggested query when no results are found for the following search" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsText": { - "message": "Нет подходящего результата поиска?", - "description": "The text for the question where the user thinks there are missing results" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { - "message": "Сообщите нам.", - "description": "The text for the link to report missing results" - }, - "theme.SearchModal.placeholder": { - "message": "Поиск", - "description": "The placeholder of the input of the DocSearch pop-up modal" - }, - "theme.common.skipToMainContent": { - "message": "Перейти к основному содержимому", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Теги", - "description": "The title of the tag list page" - } -} diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md b/docs/i18n/ru-RU/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md deleted file mode 100644 index 42d99117..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Introducing Experiments -description: A look at where task is, where it's going and how we're going to get there. -slug: task-in-2023 -authors: - - pd93 -tags: - - experiments - - breaking-changes - - roadmap - - v4 -image: https://i.imgur.com/mErPwqL.png -hide_table_of_contents: false ---- - -Lately, Task has been growing extremely quickly and I've found myself thinking a lot about the future of the project and how we continue to evolve and grow. I'm not much of a writer, but I think one of the things we could do better is to communicate these kinds of thoughts to the community. So, with that in mind, this is the first (hopefully of many) blog posts talking about Task and what we're up to. - - - -## :calendar: So, what have we been up to? - -Over the past 12 months or so, [@andreynering][] (Author and maintainer of the project) and I ([@pd93][]) have been working in our spare time to maintain and improve v3 of Task and we've made some amazing progress. Here are just some of the things we've released in that time: - -- An official [extension for VS Code][vscode-task]. -- Internal Tasks ([#818](https://github.com/go-task/task/pull/818)). -- Task aliases ([#879](https://github.com/go-task/task/pull/879)). -- Looping over tasks ([#1220](https://github.com/go-task/task/pull/1200)). -- A series of refactors to the core codebase to make it more maintainable and extensible. -- Loads of bug fixes and improvements. -- An integration with [Crowdin][crowdin]. Work is in progress on making our docs available in **7 new languages** (Special thanks to all our translators for the huge help with this!). -- And much, much more! :sparkles: - -We're also working on adding some really exciting and highly requested features to Task such as having the ability to run remote Taskfiles ([#1317](https://github.com/go-task/task/issues/1317)). - -None of this would have been possible without the [150 or so (and growing) contributors][contributors] to the project, numerous sponsors and a passionate community of users. Together we have more than doubled the number of GitHub stars to over 8400 :star: since the beginning of 2022 and this continues to accelerate. We can't thank you all enough for your help and support! :rocket: - -[![Star History Chart](https://api.star-history.com/svg?repos=go-task/task&type=Date)](https://star-history.com/#go-task/task&Date) - -## What's next? :thinking: - -It's extremely motivating to see so many people using and loving Task. However, in this time we've also seen an increase in the number of issues and feature requests. In particular, issues that require some kind of breaking change to Task. This isn't a bad thing, but as we grow we need to be more responsible about how we address these changes in a way that ensures stability and compatibility for existing users and their Taskfiles. - -At this point you're probably thinking something like: - -> "But you use [semantic versioning][semver] - Just release a new major version with your breaking changes." - -And you'd be right... sort of. In theory, this sounds great, but the reality is that we don't have the time to commit to a major overhaul of Task in one big bang release. This would require a colossal amount of time and coordination and with full time jobs and personal lives to tend to, this is a difficult commitment to make. Smaller, more frequent major releases are also a significant inconvenience for users as they have to constantly keep up-to-date with our breaking changes. Fortunately, there is a better way. - -## What's going to change? :monocle: - -Going forwards, breaking changes will be allowed into _minor_ versions of Task as "experimental features". To access these features users will need opt-in by enabling feature flags. This will allow us to release new features slowly and gather feedback from the community before making them the default behavior in a future major release. - -To prepare users for the next major release, we will maintain a list of [deprecated features][deprecations] and [experiments][experiments] on our docs website and publish information on how to migrate to the new behavior. - -You can read the [full breaking change proposal][breaking-change-proposal] and view all the [current experiments and their status][experiments-project] on GitHub including the [Gentle Force][gentle-force-experiment] and [Remote Taskfiles][remote-taskfiles-experiment] experiments. - -## What will happen to v2/v3 features? - -v2 has been [officially deprecated][deprecate-version-2-schema]. If you're still using a Taskfile with `version: "2"` at the top we _strongly recommend_ that you upgrade as soon as possible. Removing v2 will allow us to tidy up the codebase and focus on new functionality instead. - -When v4 is released, we will continue to support v3 for a period of time (bug fixes etc). However, since we are moving from a backward-compatibility model to a forwards-compatibility model, **v4 itself will not be backwards compatible with v3**. - -## v4 When? :eyes: - -:man_shrugging: When it's ready. - -In all seriousness, we don't have a timeline for this yet. We'll be working on the most serious deficiencies of the v3 API first and regularly evaluating the state of the project. When we feel its in a good, stable place and we have a clear upgrade path for users and a number of stable experiments, we'll start to think about v4. - -## :wave: Final thoughts - -Task is growing fast and we're excited to see where it goes next. We hope that the steps we're taking to improve the project and our process will help us to continue to grow. As always, if you have any questions or feedback, we encourage you to comment on or open [issues][issues] and [discussions][discussions] on GitHub. Alternatively, you can join us on [Discord][discord]. - -I plan to write more of these blog posts in the future on a variety of Task-related topics, so make sure to check in occasionally and see what we're up to! - - - - -[vscode-task]: https://github.com/go-task/vscode-task -[crowdin]: https://crowdin.com -[contributors]: https://github.com/go-task/task/graphs/contributors -[semver]: https://semver.org -[breaking-change-proposal]: https://github.com/go-task/task/discussions/1191 -[@andreynering]: https://github.com/andreynering -[@pd93]: https://github.com/pd93 -[experiments]: https://taskfile.dev/experiments -[deprecations]: https://taskfile.dev/deprecations -[deprecate-version-2-schema]: https://github.com/go-task/task/issues/1197 -[issues]: https://github.com/go-task/task/issues -[discussions]: https://github.com/go-task/task/discussions -[discord]: https://discord.gg/6TY36E39UK -[experiments-project]: https://github.com/orgs/go-task/projects/1 -[gentle-force-experiment]: https://github.com/go-task/task/issues/1200 -[remote-taskfiles-experiment]: https://github.com/go-task/task/issues/1317 diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-blog/authors.yml b/docs/i18n/ru-RU/docusaurus-plugin-content-blog/authors.yml deleted file mode 100644 index b607ea56..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-blog/authors.yml +++ /dev/null @@ -1,10 +0,0 @@ -andreynering: - name: Andrey Nering - title: Maintainer of Task - url: https://github.com/andreynering - image_url: https://github.com/andreynering.png -pd93: - name: Pete Davison - title: Maintainer of Task - url: https://github.com/pd93 - image_url: https://github.com/pd93.png diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current.json b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index dd30528d..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version.label": { - "message": "Next", - "description": "The label for version current" - } -} diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/api_reference.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/api_reference.md deleted file mode 100644 index 2831332a..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/api_reference.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -slug: /api/ -sidebar_position: 4 -toc_min_heading_level: 2 -toc_max_heading_level: 5 ---- - -# Справочник API - -## CLI - -Task command line tool has the following syntax: - -```bash -task [--flags] [tasks...] [-- CLI_ARGS...] -``` - -:::tip - -If `--` is given, all remaining arguments will be assigned to a special `CLI_ARGS` variable - -::: - -| Сокращение | Флаг | Тип | По умолчанию | Описание | -| ---------- | --------------------------- | -------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-c` | `--color` | `bool` | `true` | Colored output. Enabled by default. Set flag to `false` or use `NO_COLOR=1` to disable. | -| `-C` | `--concurrency` | `int` | `0` | Limit number tasks to run concurrently. Zero means unlimited. | -| `-d` | `--dir` | `string` | Working directory | Sets directory of execution. | -| `-n` | `--dry` | `bool` | `false` | Compiles and prints tasks in the order that they would be run, without executing them. | -| `-x` | `--exit-code` | `bool` | `false` | Pass-through the exit code of the task command. | -| `-f` | `--force` | `bool` | `false` | Forces execution even when the task is up-to-date. | -| `-g` | `--global` | `bool` | `false` | Runs global Taskfile, from `$HOME/Taskfile.{yml,yaml}`. | -| `-h` | `--help` | `bool` | `false` | Shows Task usage. | -| `-i` | `--init` | `bool` | `false` | Creates a new Taskfile.yml in the current folder. | -| `-I` | `--interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `-l` | `--list` | `bool` | `false` | Lists tasks with description of current Taskfile. | -| `-a` | `--list-all` | `bool` | `false` | Lists tasks with or without a description. | -| | `--sort` | `string` | `default` | Changes the order of the tasks when listed.
`default` - Alphanumeric with root tasks first
`alphanumeric` - Alphanumeric
`none` - No sorting (As they appear in the Taskfile) | -| | `--json` | `bool` | `false` | See [JSON Output](#json-output) | -| `-o` | `--output` | `string` | Default set in the Taskfile or `intervealed` | Sets output style: [`interleaved`/`group`/`prefixed`]. | -| | `--output-group-begin` | `string` | | Message template to print before a task's grouped output. | -| | `--output-group-end` | `string` | | Message template to print after a task's grouped output. | -| | `--output-group-error-only` | `bool` | `false` | Swallow command output on zero exit code. | -| `-p` | `--parallel` | `bool` | `false` | Executes tasks provided on command line in parallel. | -| `-s` | `--silent` | `bool` | `false` | Disables echoing. | -| `-y` | `--yes` | `bool` | `false` | Assume "yes" as answer to all prompts. | -| | `--status` | `bool` | `false` | Exits with non-zero exit code if any of the given tasks is not up-to-date. | -| | `--summary` | `bool` | `false` | Show summary about a task. | -| `-t` | `--taskfile` | `string` | `Taskfile.yml` or `Taskfile.yaml` | | -| `-v` | `--verbose` | `bool` | `false` | Enables verbose mode. | -| | `--version` | `bool` | `false` | Show Task version. | -| `-w` | `--watch` | `bool` | `false` | Enables watch of the given task. | - -## Exit Codes - -Task will sometimes exit with specific exit codes. These codes are split into three groups with the following ranges: - -- General errors (0-99) -- Taskfile errors (100-199) -- Task errors (200-299) - -A full list of the exit codes and their descriptions can be found below: - -| Code | Описание | -| ---- | ------------------------------------------------------------ | -| 0 | Success | -| 1 | An unknown error occurred | -| 100 | No Taskfile was found | -| 101 | A Taskfile already exists when trying to initialize one | -| 102 | The Taskfile is invalid or cannot be parsed | -| 103 | A remote Taskfile could not be downloaded | -| 104 | A remote Taskfile was not trusted by the user | -| 105 | A remote Taskfile was could not be fetched securely | -| 106 | No cache was found for a remote Taskfile in offline mode | -| 107 | No schema version was defined in the Taskfile | -| 200 | The specified task could not be found | -| 201 | An error occurred while executing a command inside of a task | -| 202 | The user tried to invoke a task that is internal | -| 203 | There a multiple tasks with the same name or alias | -| 204 | A task was called too many times | -| 205 | A task was cancelled by the user | -| 206 | A task was not executed due to missing required variables | - -These codes can also be found in the repository in [`errors/errors.go`](https://github.com/go-task/task/blob/main/errors/errors.go). - -:::info - -When Task is run with the `-x`/`--exit-code` flag, the exit code of any failed commands will be passed through to the user instead. - -::: - -## JSON Output - -When using the `--json` flag in combination with either the `--list` or `--list-all` flags, the output will be a JSON object with the following structure: - -```json -{ - "tasks": [ - { - "name": "", - "desc": "", - "summary": "", - "up_to_date": false, - "location": { - "line": 54, - "column": 3, - "taskfile": "/path/to/Taskfile.yml" - } - } - // ... - ], - "location": "/path/to/Taskfile.yml" -} -``` - -## Специальные переменные - -There are some special variables that is available on the templating system: - -| Переменные | Описание | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CLI_ARGS` | Contain all extra arguments passed after `--` when calling Task through the CLI. | -| `CLI_FORCE` | A boolean containing whether the `--force` or `--force-all` flags were set. | -| `TASK` | The name of the current task. | -| `ROOT_DIR` | The absolute path of the root Taskfile. | -| `TASKFILE_DIR` | The absolute path of the included Taskfile. | -| `USER_WORKING_DIR` | The absolute path of the directory `task` was called from. | -| `CHECKSUM` | The checksum of the files listed in `sources`. Only available within the `status` prop and if method is set to `checksum`. | -| `TIMESTAMP` | The date object of the greatest timestamp of the files listed in `sources`. Only available within the `status` prop and if method is set to `timestamp`. | -| `TASK_VERSION` | The current version of task. | -| `ITEM` | The value of the current iteration when using the `for` property. Can be changed to a different variable name using `as:`. | - -## ENV - -Some environment variables can be overridden to adjust Task behavior. - -| ENV | Default | Description | -| -------------------- | ------- | ----------------------------------------------------------------------------------------------------------------- | -| `TASK_TEMP_DIR` | `.task` | Location of the temp dir. Can relative to the project like `tmp/task` or absolute like `/tmp/.task` or `~/.task`. | -| `TASK_COLOR_RESET` | `0` | Color used for white. | -| `TASK_COLOR_BLUE` | `34` | Color used for blue. | -| `TASK_COLOR_GREEN` | `32` | Color used for green. | -| `TASK_COLOR_CYAN` | `36` | Color used for cyan. | -| `TASK_COLOR_YELLOW` | `33` | Color used for yellow. | -| `TASK_COLOR_MAGENTA` | `35` | Color used for magenta. | -| `TASK_COLOR_RED` | `31` | Color used for red. | -| `FORCE_COLOR` | | Force color output usage. | - -## Taskfile Schema - -| Атрибут | Тип | По умолчанию | Описание | -| ---------- | ---------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `version` | `string` | | Version of the Taskfile. The current version is `3`. | -| `output` | `string` | `interleaved` | Output mode. Available options: `interleaved`, `group` and `prefixed`. | -| `method` | `string` | `checksum` | Default method in this Taskfile. Can be overridden in a task by task basis. Available options: `checksum`, `timestamp` and `none`. | -| `includes` | [`map[string]Include`](#include) | | Additional Taskfiles to be included. | -| `vars` | [`map[string]Variable`](#variable) | | A set of global variables. | -| `env` | [`map[string]Variable`](#variable) | | A set of global environment variables. | -| `tasks` | [`map[string]Task`](#task) | | A set of task definitions. | -| `silent` | `bool` | `false` | Default 'silent' options for this Taskfile. If `false`, can be overridden with `true` in a task by task basis. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `run` | `string` | `always` | Default 'run' option for this Taskfile. Available options: `always`, `once` and `when_changed`. | -| `interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -### Include - -| Атрибут | Тип | По умолчанию | Описание | -| ---------- | --------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `taskfile` | `string` | | The path for the Taskfile or directory to be included. If a directory, Task will look for files named `Taskfile.yml` or `Taskfile.yaml` inside that directory. If a relative path, resolved relative to the directory containing the including Taskfile. | -| `dir` | `string` | The parent Taskfile directory | The working directory of the included tasks when run. | -| `optional` | `bool` | `false` | If `true`, no errors will be thrown if the specified file does not exist. | -| `internal` | `bool` | `false` | Stops any task in the included Taskfile from being callable on the command line. These commands will also be omitted from the output when used with `--list`. | -| `aliases` | `[]string` | | Alternative names for the namespace of the included Taskfile. | -| `vars` | `map[string]Variable` | | A set of variables to apply to the included Taskfile. | - -:::info - -Informing only a string like below is equivalent to setting that value to the `taskfile` attribute. - -```yaml -includes: - foo: ./path -``` - -::: - -### Variable - -| Атрибут | Тип | По умолчанию | Описание | -| -------- | -------- | ------------ | ------------------------------------------------------------------------ | -| _itself_ | `string` | | A static value that will be set to the variable. | -| `sh` | `string` | | A shell command. The output (`STDOUT`) will be assigned to the variable. | - -:::info - -Static and dynamic variables have different syntaxes, like below: - -```yaml -vars: - STATIC: static - DYNAMIC: - sh: echo "dynamic" -``` - -::: - -### Task - -| Атрибут | Тип | По умолчанию | Описание | -| --------------- | ---------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmds` | [`[]Command`](#command) | | A list of shell commands to be executed. | -| `deps` | [`[]Dependency`](#dependency) | | A list of dependencies of this task. Tasks defined here will run in parallel before this task. | -| `label` | `string` | | Overrides the name of the task in the output when a task is run. Supports variables. | -| `desc` | `string` | | A short description of the task. This is displayed when calling `task --list`. | -| `prompt` | `string` | | A prompt that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks. | -| `summary` | `string` | | A longer description of the task. This is displayed when calling `task --summary [task]`. | -| `aliases` | `[]string` | | A list of alternative names by which the task can be called. | -| `sources` | `[]string` | | A list of sources to check before running this task. Relevant for `checksum` and `timestamp` methods. Can be file paths or star globs. | -| `generates` | `[]string` | | A list of files meant to be generated by this task. Relevant for `timestamp` method. Can be file paths or star globs. | -| `status` | `[]string` | | A list of commands to check if this task should run. The task is skipped otherwise. This overrides `method`, `sources` and `generates`. | -| `requires` | `[]string` | | A list of variables which should be set if this task is to run, if any of these variables are unset the task will error and not run. | -| `preconditions` | [`[]Precondition`](#precondition) | | A list of commands to check if this task should run. If a condition is not met, the task will error. | -| `requires` | [`Requires`](#requires) | | A list of required variables which should be set if this task is to run, if any variables listed are unset the task will error and not run. | -| `dir` | `string` | | The directory in which this task should run. Defaults to the current working directory. | -| `vars` | [`map[string]Variable`](#variable) | | A set of variables that can be used in the task. | -| `env` | [`map[string]Variable`](#variable) | | A set of environment variables that will be made available to shell commands. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. When combined with the `--list` flag, task descriptions will be hidden. | -| `interactive` | `bool` | `false` | Tells task that the command is interactive. | -| `internal` | `bool` | `false` | Stops a task from being callable on the command line. It will also be omitted from the output when used with `--list`. | -| `method` | `string` | `checksum` | Defines which method is used to check the task is up-to-date. `timestamp` will compare the timestamp of the sources and generates files. `checksum` will check the checksum (You probably want to ignore the .task folder in your .gitignore file). `none` skips any validation and always run the task. | -| `prefix` | `string` | | Defines a string to prefix the output of tasks running in parallel. Only used when the output mode is `prefixed`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing commands. | -| `run` | `string` | The one declared globally in the Taskfile or `always` | Specifies whether the task should run again or not if called more than once. Available options: `always`, `once` and `when_changed`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the task should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Task will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -These alternative syntaxes are available. They will set the given values to `cmds` and everything else will be set to their default values: - -```yaml -tasks: - foo: echo "foo" - - foobar: - - echo "foo" - - echo "bar" - - baz: - cmd: echo "baz" -``` - -::: - -#### Command - -| Атрибут | Тип | По умолчанию | Описание | -| -------------- | ---------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmd` | `string` | | The shell command to be executed. | -| `task` | `string` | | Set this to trigger execution of another task instead of running a command. This cannot be set together with `cmd`. | -| `for` | [`For`](#for) | | Runs the command once for each given value. | -| `silent` | `bool` | `false` | Skips some output for this command. Note that STDOUT and STDERR of the commands will still be redirected. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to the referenced task. Only relevant when setting `task` instead of `cmd`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing the command. | -| `defer` | `string` | | Alternative to `cmd`, but schedules the command to be executed at the end of this task instead of immediately. This cannot be used together with `cmd`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the command should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Command will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -If given as a a string, the value will be assigned to `cmd`: - -```yaml -tasks: - foo: - cmds: - - echo "foo" - - echo "bar" -``` - -::: - -#### Dependency - -| Атрибут | Тип | По умолчанию | Описание | -| -------- | ---------------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------- | -| `task` | `string` | | The task to be execute as a dependency. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to this task. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. | - -:::tip - -If you don't want to set additional variables, it's enough to declare the dependency as a list of strings (they will be assigned to `task`): - -```yaml -tasks: - foo: - deps: [foo, bar] -``` - -::: - -#### For - -The `for` parameter can be defined as a string, a list of strings or a map. If it is defined as a string, you can give it any of the following values: - -- `source` - Will run the command for each source file defined on the task. (Glob patterns will be resolved, so `*.go` will run for every Go file that matches). - -If it is defined as a list of strings, the command will be run for each value. - -Finally, the `for` parameter can be defined as a map when you want to use a variable to define the values to loop over: - -| Атрибут | Тип | По умолчанию | Description | -| ------- | -------- | ---------------- | -------------------------------------------- | -| `var` | `string` | | The name of the variable to use as an input. | -| `split` | `string` | (any whitespace) | What string the variable should be split on. | -| `as` | `string` | `ITEM` | The name of the iterator variable. | - -#### Precondition - -| Attribute | Type | Default | Description | -| --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | -| `sh` | `string` | | Command to be executed. If a non-zero exit code is returned, the task errors without executing its commands. | -| `msg` | `string` | | Optional message to print if the precondition isn't met. | - -:::tip - -If you don't want to set a different message, you can declare a precondition like this and the value will be assigned to `sh`: - -```yaml -tasks: - foo: - precondition: test -f Taskfile.yml -``` - -::: - -#### Requires - -| Attribute | Type | Default | Description | -| --------- | ---------- | ------- | -------------------------------------------------------------------------------------------------- | -| `vars` | `[]string` | | List of variable or environment variable names that must be set if this task is to execute and run | diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/changelog.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/changelog.md deleted file mode 100644 index 628d35e1..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/changelog.md +++ /dev/null @@ -1,573 +0,0 @@ ---- -slug: /changelog/ -sidebar_position: 14 ---- - -# Changelog - -## v3.33.1 - 2023-12-21 - -- Added support for looping over map variables with the [Any Variables experiment](https://taskfile.dev/experiments/any_variables) enabled (#1435, #1437 by @pd93). -- Fixed a bug where dynamic variables were causing errors during fast compilation (#1435, #1437 by @pd93) - -## v3.33.0 - 2023-12-20 - -- Added [Any Variables experiment](https://taskfile.dev/experiments/any-variables) (#1415, #1421 by @pd93). -- Updated Docusaurus to v3 (#1432 by @pd93). -- Added `aliases` to `--json` flag output (#1430, #1431 by @pd93). -- Added new `CLI_FORCE` special variable containing whether the `--force` or `--force-all` flags were set (#1412, #1434 by @pd93). - -## v3.32.0 - 2023-11-29 - -- Added ability to exclude some files from `sources:` by using `exclude:` (#225, - - # 1324 by @pd93 and @andreynering). -- The [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) now prefers remote files over cached ones by default (#1317, #1345 by @pd93). -- Added `--timeout` flag to the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1345 by @pd93). -- Fix bug where dynamic `vars:` and `env:` were being executed when they should actually be skipped by `platforms:` (#1273, #1377 by @andreynering). -- Fix `schema.json` to make `silent` valid in `cmds` that use `for` (#1385, - - # 1386 by @iainvm). -- Add new `--no-status` flag to skip expensive status checks when running `task --list --json` (#1348, #1368 by @amancevice). - -## v3.31.0 - 2023-10-07 - -- Enabled the `--yes` flag for the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1344 by @pd93). -- Add ability to set `watch: true` in a task to automatically run it in watch mode (#231, #1361 by @andreynering). -- Fixed a bug on the watch mode where paths that contained `.git` (like `.github`), for example, were also being ignored (#1356 by @butuzov). -- Fixed a nil pointer error when running a Taskfile with no contents (#1341, - - # 1342 by @pd93). -- Added a new [exit code](https://taskfile.dev/api/#exit-codes) (107) for when a Taskfile does not contain a schema version (#1342 by @pd93). -- Increased limit of maximum task calls from 100 to 1000 for now, as some people have been reaching this limit organically now that we have loops. This check exists to detect recursive calls, but will be removed in favor of a better algorithm soon (#1321, #1332). -- Fixed templating on descriptions on `task --list` (#1343 by @blackjid). -- Fixed a bug where precondition errors were incorrectly being printed when task execution was aborted (#1337, #1338 by @sylv-io). - -## v3.30.1 - 2023-09-14 - -- Fixed a regression where some special variables weren't being set correctly (#1331, #1334 by @pd93). - -## v3.30.0 - 2023-09-13 - -- Prep work for Remote Taskfiles (#1316 by @pd93). -- Added the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) as a draft (#1152, #1317 by @pd93). -- Improve performance of content checksuming on `sources:` by replacing md5 with [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking change because checksums will be invalidated when upgrading to this release (#1325 by @ReillyBrogan). - -## v3.29.1 - 2023-08-26 - -- Update to Go 1.21 (bump minimum version to 1.20) (#1302 by @pd93) -- Fix a missing a line break on log when using `--watch` mode (#1285, #1297 by @FilipSolich). -- Fix `defer` on JSON Schema (#1288 by @calvinmclean and @andreynering). -- Fix bug in usage of special variables like `{{.USER_WORKING_DIR}}` in combination with `includes` (#1046, #1205, #1250, #1293, #1312, #1274 by @andarto, #1309 by @andreynering). -- Fix bug on `--status` flag. Running this flag should not have side-effects: it should not update the checksum on `.task`, only report its status (#1305, - - # 1307 by @visciang, #1313 by @andreynering). - -## v3.28.0 - 2023-07-24 - -- Added the ability to [loop over commands and tasks](https://taskfile.dev/usage/#looping-over-values) using `for` (#82, #1220 by @pd93). -- Fixed variable propagation in multi-level includes (#778, #996, #1256 by @hudclark). -- Fixed a bug where the `--exit-code` code flag was not returning the correct exit code when calling commands indirectly (#1266, #1270 by @pd93). -- Fixed a `nil` panic when a dependency was commented out or left empty (#1263 by @neomantra). - -## v3.27.1 - 2023-06-30 - -- Fix panic when a `.env` directory (not file) is present on current directory (#1244, #1245 by @pd93). - -## v3.27.0 - 2023-06-29 - -- Allow Taskfiles starting with lowercase characters (#947, #1221 by @pd93). - - e.g. `taskfile.yml`, `taskfile.yaml`, `taskfile.dist.yml` & `taskfile.dist.yaml` -- Bug fixes were made to the [npm installation method](https://taskfile.dev/installation/#npm). (#1190, by @sounisi5011). -- Added the [gentle force experiment](https://taskfile.dev/experiments/gentle-force) as a draft (#1200, #1216 by @pd93). -- Added an `--experiments` flag to allow you to see which experiments are enabled (#1242 by @pd93). -- Added ability to specify which variables are required in a task (#1203, #1204 by @benc-uk). - -## v3.26.0 - 2023-06-10 - -- Only rewrite checksum files in `.task` if the checksum has changed (#1185, - - # 1194 by @deviantintegral). -- Added [experiments documentation](https://taskfile.dev/experiments) to the website (#1198 by @pd93). -- Deprecated `version: 2` schema. This will be removed in the next major release (#1197, #1198, #1199 by @pd93). -- Added a new `prompt:` prop to set a warning prompt to be shown before running a potential dangurous task (#100, #1163 by @MaxCheetham, [Documentation](https://taskfile.dev/usage/#warning-prompts)). -- Added support for single command task syntax. With this change, it's now possible to declare just `cmd:` in a task, avoiding the more complex `cmds: []` when you have only a single command for that task (#1130, #1131 by @timdp). - -## v3.25.0 - 2023-05-22 - -- Support `silent:` when calling another tasks (#680, #1142 by @danquah). -- Improve PowerShell completion script (#1168 by @trim21). -- Add more languages to the website menu and show translation progress percentage (#1173 by @misitebao). -- Starting on this release, official binaries for FreeBSD will be available to download (#1068 by @andreynering). -- Fix some errors being unintendedly supressed (#1134 by @clintmod). -- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - - # 1149 by @pd93). -- Fix duplicate error message when a task does not exists (#1141, #1144 by @pd93). - -## v3.24.0 - 2023-04-15 - -- Fix Fish shell completion for tasks with aliases (#1113 by @patricksjackson). -- The default branch was renamed from `master` to `main` (#1049, #1048 by @pd93). -- Fix bug where "up-to-date" logs were not being omitted for silent tasks (#546, - - # 1107 by @danquah). -- Add `.hg` (Mercurial) to the list of ignored directories when using `--watch` (#1098 by @misery). -- More improvements to the release tool (#1096 by @pd93). -- Enforce [gofumpt](https://github.com/mvdan/gofumpt) linter (#1099 by @pd93) -- Add `--sort` flag for use with `--list` and `--list-all` (#946, #1105 by @pd93). -- Task now has [custom exit codes](https://taskfile.dev/api/#exit-codes) depending on the error (#1114 by @pd93). - -## v3.23.0 - 2023-03-26 - -Task now has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task) contributed by @pd93! :tada: The extension is maintained in a [new repository](https://github.com/go-task/vscode-task) under the `go-task` organization. We're looking to gather feedback from the community so please give it a go and let us know what you think via a [discussion](https://github.com/go-task/vscode-task/discussions), [issue](https://github.com/go-task/vscode-task/issues) or on our [Discord](https://discord.gg/6TY36E39UK)! - -> **NOTE:** The extension _requires_ v3.23.0 to be installed in order to work. - -- The website was integrated with [Crowdin](https://crowdin.com/project/taskfile) to allow the community to contribute with translations! [Chinese](https://taskfile.dev/zh-Hans/) is the first language available (#1057, #1058 by @misitebao). -- Added task location data to the `--json` flag output (#1056 by @pd93) -- Change the name of the file generated by `task --init` from `Taskfile.yaml` to `Taskfile.yml` (#1062 by @misitebao). -- Added new `splitArgs` template function (`{{splitArgs "foo bar 'foo bar baz'"}}`) to ensure string is split as arguments (#1040, #1059 by @dhanusaputra). -- Fix the value of `{{.CHECKSUM}}` variable in status (#1076, #1080 by @pd93). -- Fixed deep copy implementation (#1072 by @pd93) -- Created a tool to assist with releases (#1086 by @pd93). - -## v3.22.0 - 2023-03-10 - -- Add a brand new `--global` (`-g`) flag that will run a Taskfile from your `$HOME` directory. This is useful to have automation that you can run from anywhere in your system! ([Documentation](https://taskfile.dev/usage/#running-a-global-taskfile), #1029 by @andreynering). -- Add ability to set `error_only: true` on the `group` output mode. This will instruct Task to only print a command output if it returned with a non-zero exit code (#664, #1022 by @jaedle). -- Fixed bug where `.task/checksum` file was sometimes not being created when task also declares a `status:` (#840, #1035 by @harelwa, #1037 by @pd93). -- Refactored and decoupled fingerprinting from the main Task executor (#1039 by @pd93). -- Fixed deadlock issue when using `run: once` (#715, #1025 by @theunrepentantgeek). - -## v3.21.0 - 2023-02-22 - -- Added new `TASK_VERSION` special variable (#990, #1014 by @ja1code). -- Fixed a bug where tasks were sometimes incorrectly marked as internal (#1007 by @pd93). -- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) -- Added environment variable `FORCE_COLOR` support to force color output. Usefull for environments without TTY (#1003 by @automation-stack) - -## v3.20.0 - 2023-01-14 - -- Improve behavior and performance of status checking when using the `timestamp` mode (#976, #977 by @aminya). -- Performance optimizations were made for large Taskfiles (#982 by @pd93). -- Add ability to configure options for the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins (#908, #929 by @pd93, [Documentation](http://taskfile.dev/usage/#set-and-shopt)). -- Add new `platforms:` attribute to `task` and `cmd`, so it's now possible to choose in which platforms that given task or command will be run on. Possible values are operating system (GOOS), architecture (GOARCH) or a combination of the two. Example: `platforms: [linux]`, `platforms: [amd64]` or `platforms: [linux/amd64]`. Other platforms will be skipped (#978, #980 by @leaanthony). - -## v3.19.1 - 2022-12-31 - -- Small bug fix: closing `Taskfile.yml` once we're done reading it (#963, #964 by @HeCorr). -- Fixes a bug in v2 that caused a panic when using a `Taskfile_{{OS}}.yml` file (#961, #971 by @pd93). -- Fixed a bug where watch intervals set in the Taskfile were not being respected (#969, #970 by @pd93) -- Add `--json` flag (alias `-j`) with the intent to improve support for code editors and add room to other possible integrations. This is basic for now, but we plan to add more info in the near future (#936 by @davidalpert, #764). - -## v3.19.0 - 2022-12-05 - -- Installation via npm now supports [pnpm](https://pnpm.io/) as well ([go-task/go-npm#2](https://github.com/go-task/go-npm/issues/2), [go-task/go-npm#3](https://github.com/go-task/go-npm/pull/3)). -- It's now possible to run Taskfiles from subdirectories! A new `USER_WORKING_DIR` special variable was added to add even more flexibility for monorepos (#289, #920). -- Add task-level `dotenv` support (#389, #904). -- It's now possible to use global level variables on `includes` (#942, #943). -- The website got a brand new [translation to Chinese](https://task-zh.readthedocs.io/zh_CN/latest/) by [@DeronW](https://github.com/DeronW). Thanks! - -## v3.18.0 - 2022-11-12 - -- Show aliases on `task --list --silent` (`task --ls`). This means that aliases will be completed by the completion scripts (#919). -- Tasks in the root Taskfile will now be displayed first in `--list`/`--list-all` output (#806, #890). -- It's now possible to call a `default` task in an included Taskfile by using just the namespace. For example: `docs:default` is now automatically aliased to `docs` (#661, #815). - -## v3.17.0 - 2022-10-14 - -- Add a "Did you mean ...?" suggestion when a task does not exits another one with a similar name is found (#867, #880). -- Now YAML parse errors will print which Taskfile failed to parse (#885, #887). -- Add ability to set `aliases` for tasks and namespaces (#268, #340, #879). -- Improvements to Fish shell completion (#897). -- Added ability to set a different watch interval by setting `interval: '500ms'` or using the `--interval=500ms` flag (#813, #865). -- Add colored output to `--list`, `--list-all` and `--summary` flags (#845, - - # 874). -- Fix unexpected behavior where `label:` was being shown instead of the task name on `--list` (#603, #877). - -## v3.16.0 - 2022-09-29 - -- Add `npm` as new installation method: `npm i -g @go-task/cli` (#870, #871, [npm package](https://www.npmjs.com/package/@go-task/cli)). -- Add support to marking tasks and includes as internal, which will hide them from `--list` and `--list-all` (#818). - -## v3.15.2 - 2022-09-08 - -- Fix error when using variable in `env:` introduced in the previous release (#858, #866). -- Fix handling of `CLI_ARGS` (`--`) in Bash completion (#863). -- On zsh completion, add ability to replace `--list-all` with `--list` as already possible on the Bash completion (#861). - -## v3.15.0 - 2022-09-03 - -- Add new special variables `ROOT_DIR` and `TASKFILE_DIR`. This was a highly requested feature (#215, #857, [Documentation](https://taskfile.dev/api/#special-variables)). -- Follow symlinks on `sources` (#826, #831). -- Improvements and fixes to Bash completion (#835, #844). - -## v3.14.1 - 2022-08-03 - -- Always resolve relative include paths relative to the including Taskfile (#822, #823). -- Fix ZSH and PowerShell completions to consider all tasks instead of just the public ones (those with descriptions) (#803). - -## v3.14.0 - 2022-07-08 - -- Add ability to override the `.task` directory location with the `TASK_TEMP_DIR` environment variable. -- Allow to override Task colors using environment variables: `TASK_COLOR_RESET`, `TASK_COLOR_BLUE`, `TASK_COLOR_GREEN`, `TASK_COLOR_CYAN`, `TASK_COLOR_YELLOW`, `TASK_COLOR_MAGENTA` and `TASK_COLOR_RED` (#568, #792). -- Fixed bug when using the `output: group` mode where STDOUT and STDERR were being print in separated blocks instead of in the right order (#779). -- Starting on this release, ARM architecture binaries are been released to Snap as well (#795). -- i386 binaries won't be available anymore on Snap because Ubuntu removed the support for this architecture. -- Upgrade mvdan.cc/sh, which fixes a bug with associative arrays (#785, [mvdan/sh#884](https://github.com/mvdan/sh/issues/884), [mvdan/sh#893](https://github.com/mvdan/sh/pull/893)). - -## v3.13.0 - 2022-06-13 - -- Added `-n` as an alias to `--dry` (#776, #777). -- Fix behavior of interrupt (SIGINT, SIGTERM) signals. Task will now give time for the processes running to do cleanup work (#458, #479, #728, #769). -- Add new `--exit-code` (`-x`) flag that will pass-through the exit form the command being ran (#755). - -## v3.12.1 - 2022-05-10 - -- Fixed bug where, on Windows, variables were ending with `\r` because we were only removing the final `\n` but not `\r\n` (#717). - -## v3.12.0 - 2022-03-31 - -- The `--list` and `--list-all` flags can now be combined with the `--silent` flag to print the task names only, without their description (#691). -- Added support for multi-level inclusion of Taskfiles. This means that included Taskfiles can also include other Taskfiles. Before this was limited to one level (#390, #623, #656). -- Add ability to specify vars when including a Taskfile. [Check out the documentation](https://taskfile.dev/#/usage?id=vars-of-included-taskfiles) for more information (#677). - -## v3.11.0 - 2022-02-19 - -- Task now supports printing begin and end messages when using the `group` output mode, useful for grouping tasks in CI systems. [Check out the documentation](http://taskfile.dev/#/usage?id=output-syntax) for more information (#647, #651). -- Add `Taskfile.dist.yml` and `Taskfile.dist.yaml` to the supported file name list. [Check out the documentation](https://taskfile.dev/#/usage?id=supported-file-names) for more information (#498, #666). - -## v3.10.0 - 2022-01-04 - -- A new `--list-all` (alias `-a`) flag is now available. It's similar to the exiting `--list` (`-l`) but prints all tasks, even those without a description (#383, #401). -- It's now possible to schedule cleanup commands to run once a task finishes with the `defer:` keyword ([Documentation](https://taskfile.dev/#/usage?id=doing-task-cleanup-with-defer), - - # 475, #626). -- Remove long deprecated and undocumented `$` variable prefix and `^` command prefix (#642, #644, #645). -- Add support for `.yaml` extension (as an alternative to `.yml`). This was requested multiple times throughout the years. Enjoy! (#183, #184, #369, #584, - - # 621). -- Fixed error when computing a variable when the task directory do not exist yet (#481, #579). - -## v3.9.2 - 2021-12-02 - -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains a fix a for a important regression on Windows (#619, [mvdan/sh#768](https://github.com/mvdan/sh/issues/768), [mvdan/sh#769](https://github.com/mvdan/sh/pull/769)). - -## v3.9.1 - 2021-11-28 - -- Add logging in verbose mode for when a task starts and finishes (#533, #588). -- Fix an issue with preconditions and context errors (#597, #598). -- Quote each `{{.CLI_ARGS}}` argument to prevent one with spaces to become many (#613). -- Fix nil pointer when `cmd:` was left empty (#612, #614). -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains two relevant fixes: - - Fix quote of empty strings in `shellQuote` (#609, [mvdan/sh#763](https://github.com/mvdan/sh/issues/763)). - - Fix issue of wrong environment variable being picked when there's another very similar one (#586, [mvdan/sh#745](https://github.com/mvdan/sh/pull/745)). -- Install shell completions automatically when installing via Homebrew (#264, #592, [go-task/homebrew-tap#2](https://github.com/go-task/homebrew-tap/pull/2)). - -## v3.9.0 - 2021-10-02 - -- A new `shellQuote` function was added to the template system (`{{shellQuote "a string"}}`) to ensure a string is safe for use in shell ([mvdan/sh#727](https://github.com/mvdan/sh/pull/727), [mvdan/sh#737](https://github.com/mvdan/sh/pull/737), [Documentation](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)) -- In this version [mvdan.cc/sh](https://github.com/mvdan/sh) was upgraded with some small fixes and features - - The `read -p` flag is now supported (#314, [mvdan/sh#551](https://github.com/mvdan/sh/issues/551), [mvdan/sh#772](https://github.com/mvdan/sh/pull/722)) - - The `pwd -P` and `pwd -L` flags are now supported (#553, [mvdan/sh#724](https://github.com/mvdan/sh/issues/724), [mvdan/sh#728](https://github.com/mvdan/sh/pull/728)) - - The `$GID` environment variable is now correctly being set (#561, [mvdan/sh#723](https://github.com/mvdan/sh/pull/723)) - -## v3.8.0 - 2021-09-26 - -- Add `interactive: true` setting to improve support for interactive CLI apps (#217, #563). -- Fix some `nil` errors (#534, #573). -- Add ability to declare an included Taskfile as optional (#519, #552). -- Add support for including Taskfiles in the home directory by using `~` (#539, #557). - -## v3.7.3 - 2021-09-04 - -- Add official support to Apple M1 (#564, #567). -- Our [official Homebrew tap](https://github.com/go-task/homebrew-tap) will support more platforms, including Apple M1 - -## v3.7.0 - 2021-07-31 - -- Add `run:` setting to control if tasks should run multiple times or not. Available options are `always` (the default), `when_changed` (if a variable modified the task) and `once` (run only once no matter what). This is a long time requested feature. Enjoy! (#53, #359). - -## v3.6.0 - 2021-07-10 - -- Allow using both `sources:` and `status:` in the same task (#411, #427, #477). -- Small optimization and bug fix: don't compute variables if not needed for `dotenv:` (#517). - -## v3.5.0 - 2021-07-04 - -- Add support for interpolation in `dotenv:` (#433, #434, #453). - -## v3.4.3 - 2021-05-30 - -- Add support for the `NO_COLOR` environment variable. (#459, [fatih/color#137](https://github.com/fatih/color/pull/137)). -- Fix bug where sources were not considering the right directory in `--watch` mode (#484, #485). - -## v3.4.2 - 2021-04-23 - -- On watch, report which file failed to read (#472). -- Do not try to catch SIGKILL signal, which are not actually possible (#476). -- Improve version reporting when building Task from source using Go Modules (#462, #473). - -## v3.4.1 - 2021-04-17 - -- Improve error reporting when parsing YAML: in some situations where you would just see an generic error, you'll now see the actual error with more detail: the YAML line the failed to parse, for example (#467). -- A JSON Schema was published [here](https://json.schemastore.org/taskfile.json) and is automatically being used by some editors like Visual Studio Code (#135). -- Print task name before the command in the log output (#398). - -## v3.3.0 - 2021-03-20 - -- Add support for delegating CLI arguments to commands with `--` and a special `CLI_ARGS` variable (#327). -- Add a `--concurrency` (alias `-C`) flag, to limit the number of tasks that run concurrently. This is useful for heavy workloads. (#345). - -## v3.2.2 - 2021-01-12 - -- Improve performance of `--list` and `--summary` by skipping running shell variables for these flags (#332). -- Fixed a bug where an environment in a Taskfile was not always overridable by the system environment (#425). -- Fixed environment from .env files not being available as variables (#379). -- The install script is now working for ARM platforms (#428). - -## v3.2.1 - 2021-01-09 - -- Fixed some bugs and regressions regarding dynamic variables and directories (#426). -- The [slim-sprig](https://github.com/go-task/slim-sprig) package was updated with the upstream [sprig](https://github.com/Masterminds/sprig). - -## v3.2.0 - 2021-01-07 - -- Fix the `.task` directory being created in the task directory instead of the Taskfile directory (#247). -- Fix a bug where dynamic variables (those declared with `sh:`) were not running in the task directory when the task has a custom dir or it was in an included Taskfile (#384). -- The watch feature (via the `--watch` flag) got a few different bug fixes and should be more stable now (#423, #365). - -## v3.1.0 - 2021-01-03 - -- Fix a bug when the checksum up-to-date resolution is used by a task with a custom `label:` attribute (#412). -- Starting from this release, we're releasing official ARMv6 and ARM64 binaries for Linux (#375, #418). -- Task now respects the order of declaration of included Taskfiles when evaluating variables declaring by them (#393). -- `set -e` is now automatically set on every command. This was done to fix an issue where multiline string commands wouldn't really fail unless the sentence was in the last line (#403). - -## v3.0.1 - 2020-12-26 - -- Allow use as a library by moving the required packages out of the `internal` directory (#358). -- Do not error if a specified dotenv file does not exist (#378, #385). -- Fix panic when you have empty tasks in your Taskfile (#338, #362). - -## v3.0.0 - 2020-08-16 - -- On `v3`, all CLI variables will be considered global variables (#336, #341) -- Add support to `.env` like files (#324, #356). -- Add `label:` to task so you can override the task name in the logs (#321, - - # 337). -- Refactor how variables work on version 3 (#311). -- Disallow `expansions` on v3 since it has no effect. -- `Taskvars.yml` is not automatically included anymore. -- `Taskfile_{{OS}}.yml` is not automatically included anymore. -- Allow interpolation on `includes`, so you can manually include a Taskfile based on operation system, for example. -- Expose `.TASK` variable in templates with the task name (#252). -- Implement short task syntax (#194, #240). -- Added option to make included Taskfile run commands on its own directory (#260, #144) -- Taskfiles in version 1 are not supported anymore (#237). -- Added global `method:` option. With this option, you can set a default method to all tasks in a Taskfile (#246). -- Changed default method from `timestamp` to `checksum` (#246). -- New magic variables are now available when using `status:`: `.TIMESTAMP` which contains the greatest modification date from the files listed in `sources:`, and `.CHECKSUM`, which contains a checksum of all files listed in `status:`. This is useful for manual checking when using external, or even remote, artifacts when using `status:` (#216). -- We're now using [slim-sprig](https://github.com/go-task/slim-sprig) instead of [sprig](https://github.com/Masterminds/sprig), which allowed a file size reduction of about 22% (#219). -- We now use some colors on Task output to better distinguish message types - commands are green, errors are red, etc (#207). - -## v2.8.1 - 2020-05-20 - -- Fix error code for the `--help` flag (#300, #330). -- Print version to stdout instead of stderr (#299, #329). -- Supress `context` errors when using the `--watch` flag (#313, #317). -- Support templating on description (#276, #283). - -## v2.8.0 - 2019-12-07 - -- Add `--parallel` flag (alias `-p`) to run tasks given by the command line in parallel (#266). -- Fixed bug where calling the `task` CLI only informing global vars would not execute the `default` task. -- Add hability to silent all tasks by adding `silent: true` a the root of the Taskfile. - -## v2.7.1 - 2019-11-10 - -- Fix error being raised when `exit 0` was called (#251). - -## v2.7.0 - 2019-09-22 - -- Fixed panic bug when assigning a global variable (#229, #243). -- A task with `method: checksum` will now re-run if generated files are deleted (#228, #238). - -## v2.6.0 - 2019-07-21 - -- Fixed some bugs regarding minor version checks on `version:`. -- Add `preconditions:` to task (#205). -- Create directory informed on `dir:` if it doesn't exist (#209, #211). -- We now have a `--taskfile` flag (alias `-t`), which can be used to run another Taskfile (other than the default `Taskfile.yml`) (#221). -- It's now possible to install Task using Homebrew on Linux ([go-task/homebrew-tap#1](https://github.com/go-task/homebrew-tap/pull/1)). - -## v2.5.2 - 2019-05-11 - -- Reverted YAML upgrade due issues with CRLF on Windows (#201, [go-yaml/yaml#450](https://github.com/go-yaml/yaml/issues/450)). -- Allow setting global variables through the CLI (#192). - -## 2.5.1 - 2019-04-27 - -- Fixed some issues with interactive command line tools, where sometimes the output were not being shown, and similar issues (#114, #190, #200). -- Upgraded [go-yaml/yaml](https://github.com/go-yaml/yaml) from v2 to v3. - -## v2.5.0 - 2019-03-16 - -- We moved from the taskfile.org domain to the new fancy taskfile.dev domain. While stuff is being redirected, we strongly recommend to everyone that use [this install script](https://taskfile.dev/#/installation?id=install-script) to use the new taskfile.dev domain on scripts from now on. -- Fixed to the ZSH completion (#182). -- Add [`--summary` flag along with `summary:` task attribute](https://taskfile.org/#/usage?id=display-summary-of-task) (#180). - -## v2.4.0 - 2019-02-21 - -- Allow calling a task of the root Taskfile from an included Taskfile by prefixing it with `:` (#161, #172). -- Add flag to override the `output` option (#173). -- Fix bug where Task was persisting the new checksum on the disk when the Dry Mode is enabled (#166). -- Fix file timestamp issue when the file name has spaces (#176). -- Mitigating path expanding issues on Windows (#170). - -## v2.3.0 - 2019-01-02 - -- On Windows, Task can now be installed using [Scoop](https://scoop.sh/) (#152). -- Fixed issue with file/directory globing (#153). -- Added ability to globally set environment variables (#138, #159). - -## v2.2.1 - 2018-12-09 - -- This repository now uses Go Modules (#143). We'll still keep the `vendor` directory in sync for some time, though; -- Fixing a bug when the Taskfile has no tasks but includes another Taskfile (#150); -- Fix a bug when calling another task or a dependency in an included Taskfile (#151). - -## v2.2.0 - 2018-10-25 - -- Added support for [including other Taskfiles](https://taskfile.org/#/usage?id=including-other-taskfiles) (#98) - - This should be considered experimental. For now, only including local files is supported, but support for including remote Taskfiles is being discussed. If you have any feedback, please comment on #98. -- Task now have a dedicated documentation site: https://taskfile.org - - Thanks to [Docsify](https://docsify.js.org/) for making this pretty easy. To check the source code, just take a look at the [docs](https://github.com/go-task/task/tree/main/docs) directory of this repository. Contributions to the documentation is really appreciated. - -## v2.1.1 - 2018-09-17 - -- Fix suggestion to use `task --init` not being shown anymore (when a `Taskfile.yml` is not found) -- Fix error when using checksum method and no file exists for a source glob (#131) -- Fix signal handling when the `--watch` flag is given (#132) - -## v2.1.0 - 2018-08-19 - -- Add a `ignore_error` option to task and command (#123) -- Add a dry run mode (`--dry` flag) (#126) - -## v2.0.3 - 2018-06-24 - -- Expand environment variables on "dir", "sources" and "generates" (#116) -- Fix YAML merging syntax (#112) -- Add ZSH completion (#111) -- Implement new `output` option. Please check out the [documentation](https://github.com/go-task/task#output-syntax) - -## v2.0.2 - 2018-05-01 - -- Fix merging of YAML anchors (#112) - -## v2.0.1 - 2018-03-11 - -- Fixes panic on `task --list` - -## v2.0.0 - 2018-03-08 - -Version 2.0.0 is here, with a new Taskfile format. - -Please, make sure to read the [Taskfile versions](https://github.com/go-task/task/blob/main/TASKFILE_VERSIONS.md) document, since it describes in depth what changed for this version. - -- New Taskfile version 2 (#77) -- Possibility to have global variables in the `Taskfile.yml` instead of `Taskvars.yml` (#66) -- Small improvements and fixes - -## v1.4.4 - 2017-11-19 - -- Handle SIGINT and SIGTERM (#75); -- List: print message with there's no task with description; -- Expand home dir ("~" symbol) on paths (#74); -- Add Snap as an installation method; -- Move examples to its own repo; -- Watch: also walk on tasks called on on "cmds", and not only on "deps"; -- Print logs to stderr instead of stdout (#68); -- Remove deprecated `set` keyword; -- Add checksum based status check, alternative to timestamp based. - -## v1.4.3 - 2017-09-07 - -- Allow assigning variables to tasks at run time via CLI (#33) -- Added suport for multiline variables from sh (#64) -- Fixes env: remove square braces and evaluate shell (#62) -- Watch: change watch library and few fixes and improvements -- When use watching, cancel and restart long running process on file change (#59 and #60) - -## v1.4.2 - 2017-07-30 - -- Flag to set directory of execution -- Always echo command if is verbose mode -- Add silent mode to disable echoing of commands -- Fixes and improvements of variables (#56) - -## v1.4.1 - 2017-07-15 - -- Allow use of YAML for dynamic variables instead of $ prefix - - `VAR: {sh: echo Hello}` instead of `VAR: $echo Hello` -- Add `--list` (or `-l`) flag to print existing tasks -- OS specific Taskvars file (e.g. `Taskvars_windows.yml`, `Taskvars_linux.yml`, etc) -- Consider task up-to-date on equal timestamps (#49) -- Allow absolute path in generates section (#48) -- Bugfix: allow templating when calling deps (#42) -- Fix panic for invalid task in cyclic dep detection -- Better error output for dynamic variables in Taskvars.yml (#41) -- Allow template evaluation in parameters - -## v1.4.0 - 2017-07-06 - -- Cache dynamic variables -- Add verbose mode (`-v` flag) -- Support to task parameters (overriding vars) (#31) (#32) -- Print command, also when "set:" is specified (#35) -- Improve task command help text (#35) - -## v1.3.1 - 2017-06-14 - -- Fix glob not working on commands (#28) -- Add ExeExt template function -- Add `--init` flag to create a new Taskfile -- Add status option to prevent task from running (#27) -- Allow interpolation on `generates` and `sources` attributes (#26) - -## v1.3.0 - 2017-04-24 - -- Migrate from os/exec.Cmd to a native Go sh/bash interpreter - - This is a potentially breaking change if you use Windows. - - Now, `cmd` is not used anymore on Windows. Always use Bash-like syntax for your commands, even on Windows. -- Add "ToSlash" and "FromSlash" to template functions -- Use functions defined on github.com/Masterminds/sprig -- Do not redirect stdin while running variables commands -- Using `context` and `errgroup` packages (this will make other tasks to be cancelled, if one returned an error) - -## v1.2.0 - 2017-04-02 - -- More tests and Travis integration -- Watch a task (experimental) -- Possibility to call another task -- Fix "=" not being reconized in variables/environment variables -- Tasks can now have a description, and help will print them (#10) -- Task dependencies now run concurrently -- Support for a default task (#16) - -## v1.1.0 - 2017-03-08 - -- Support for YAML, TOML and JSON (#1) -- Support running command in another directory (#4) -- `--force` or `-f` flag to force execution of task even when it's up-to-date -- Detection of cyclic dependencies (#5) -- Support for variables (#6, #9, #14) -- Operation System specific commands and variables (#13) - -## v1.0.0 - 2017-02-28 - -- Add LICENSE file diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/community.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/community.md deleted file mode 100644 index 8165c0e8..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/community.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -slug: /community/ -sidebar_position: 9 ---- - -# Сообщество - -Некоторые из работ по улучшению экосистемы Task выполняются сообществом, будь то методы установки или интеграция с редактором кода. Я (автор) благодарен всем, кто помогает мне улучшить продукт. - -## Переводчики - -We use [Crowdin](https://crowdin.com/project/taskfile) to translate our document. - -## Интеграции - -Многие из наших интеграций развиваются и поддерживаются сообществом. Вы можете просмотреть полный список интеграции [здесь](/integrations#community-integrations). - -## Способы установки - -Некоторые методы установки поддерживаются третьими лицами: - -- [GitHub Actions](https://github.com/arduino/setup-task) by @arduino -- [AUR](https://aur.archlinux.org/packages/go-task-bin) by @carlsmedstad -- [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json) -- [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) -- [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/go-task/default.nix) -- [Conda](https://github.com/conda-forge/go-task-feedstock/) - -## Дополнительно - -Кроме того, спасибо всем [разработчикам кода](https://github.com/go-task/task/graphs/contributors), [финансовым вкладчикам](https://opencollective.com/task), всем тем, кто [сообщил об ошибках](https://github.com/go-task/task/issues?q=is%3Aissue) и [ответил на вопросы](https://github.com/go-task/task/discussions). - -Если вы знаете что-то, что отсутствует в этом документе, отправьте PR. diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/contributing.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/contributing.md deleted file mode 100644 index 4f6ed87b..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/contributing.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -slug: /contributing/ -sidebar_position: 11 ---- - -# Помощь проекту - -Любой вклад в Task очень приветствуется, но мы просим вас прочитать этот документ, прежде чем отправлять pull request(PR). - -:::note - -Этот документ относится к основному репозиторию [Task][task] _и_ [ Task for Visual Studio Code][vscode-task] - -::: - -## Введение - -- **Текущее состояние разработки** - Проверьте уже открытые PR. Есть ли открытые "issues", обсуждающие особенности/изменения, которые вы хотите выполнить? Пожалуйста, убедитесь, что вы учитываете результаты этих обсуждений в своей работе. -- **Обратная совместимость** - Повлияют ли ваши изменения на уже существующие TaskFile'ы? Скорее всего, ваше изменение будет применено, если оно обладает обратной совместимостью. Существует ли подход, который вы можете использовать для поддержания обратной совместимости? Если нет, откройте проблему(Вот тут ["Issues"](https://github.com/go-task/task/issues)), чтобы изменения API могли быть обсуждены до того, как вы потратите своё время на PR. -- **Experiments** - If there is no way to make your change backward compatible then there is a procedure to introduce breaking changes into minor versions. We call these "\[experiments\]\[experiments\]". If you're intending to work on an experiment, then please read the \[experiments workflow\]\[experiments-workflow\] document carefully and submit a proposal first. - -## 1. Настройка - -- **Go** - Task написан на [Go][go]. Мы всегда поддерживаем две последних основных версий Go, поэтому убедитесь, что у вас установлена актуальная версия. -- **Node.js** - [Node.js][nodejs] используется для хостинга сервера документации Task и требуется для локального запуска этого сервера. Node.js также необходим для того, чтобы внести свой вклад в расширение Visual Studio Code. -- **Yarn** - [Yarn][yarn] является менеджером пакетов Node.js, используемым в Task. - -## 2. Внести изменения - -- **Code style** - Настоятельно рекомендуем поддерживать существующий стиль кода по мере возможности. Код должен быть отформатирован [`gofumpt`][gofumpt] и проверен [`golangci-lint`][golangci-lint] линтером. Любые файлы Markdown или TypeScript должны быть отформатированы с помощью [Prettier][prettier]. Стиль кода внедряется нашим CI для обеспечения того, чтобы у всех был одинаковый стиль кода в рамках проекта. Вы можете использовать команду `task lint` для локальной проверки линтером и `task lint:fix` для автоматического исправления любых обнаруженных проблем. -- **Документация** - Убедитесь, что вы добавляете/обновляете любую соответствующую документацию. Секцию [обновления документации](#updating-documentation) можно увидеть ниже. -- **Тесты** - Убедитесь, что вы добавляете/обновляете любые релевантные тесты и что все тесты проходят перед отправкой PR. Секцию [написание тестов](#writing-tests) можно увидеть ниже. - -### Запуск ваших изменений - -Чтобы запустить Task с рабочими изменениями, используйте `go run ./cmd/task`. Для запуска тестовой сборки задачи с Taskfile в `testdata`, вы можете использовать `go run ./cmd/task --dir ./testdata/ `. - -Для запуска Task для Visual Studio кода, вы можете открыть проект в VSCode и нажать F5 (или любую другую клавишу, к которой вы привязали функцию отладки). Это откроет новое окно VSCode с запущенным расширением. Мы рекомендуем использовать функцию отладки, так как это позволит вам задать точки останова. Также вы можете запустить пакет задач `task package` для генерации `.vsix` файла, который может быть использован для ручной установки расширения. - -### Обновление документации - -Task использует [Docusaurus][docusaurus] для размещения сервера документации. Код для неё находится в основном Task репозитории. Документация может быть настроена и запущена локально с помощью `task docs` (требуется установка `nodejs` & `yarn`). Все содержимое написано в Markdown и находится в директории `docs/docs`. Все документы Markdown должны иметь максимальную длину строки 80 символов (этого требует Prettier). - -When making a change, consider whether a change to the [Usage Guide](/usage) is necessary. This document contains descriptions and examples of how to use Task features. If you're adding a new feature, try to find an appropriate place to add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](/styleguide). - -If you added a new field, command or flag, ensure that you add it to the [API Reference](/api). Новые поля также необходимо добавить в [JSON][json-schema] схему. Описания полей в справочнике API и JSON схеме должны совпадать. - -### Написание тестов - -Тесты расположены в файле `task_test.go` в корневом каталоге, рекомендуем добавлять новые тесты именно в него. Большинство этих тестов также имеют поддиректорию в `testdata`, где хранятся любые Taskfiles/данные, необходимые для запуска тестов. - -При внесении изменений подумайте о необходимости новых тестов. Эти тесты должны гарантировать, что функционал, который вы добавили, продолжит работу в будущем. Существующие тесты также могут потребовать обновления, если вы изменили поведение Task. - -Вы также можете добавить модульный тест для любых новых функций, которые добавляете. Модульные тесты должны следовать Go соглашению о местоположении в файле `*_test.o` в том же пакете, что и тестируемый код. - -## 3. Внесение кода - -Попробуйте написать содержательное сообщение к коммиту и не иметь слишком много коммитов в PR. Большинство PR, желательно, должны иметь один коммит (хотя для больших PR может быть разумным разделить его несколько коммитов). Используйте git squash и rebase! - -Если вы не уверены, как отформатировать ваше сообщение, проверьте [Соглашение о коммитах][conventional-commits]. Этот стиль не используется в проекте, но это хороший способ сделать ваше сообщение для коммита более читаемым и последовательным. - -## 4. Отправка PR - -- **Опишите ваши изменения** - Убедитесь, что вы предоставили подробное описание ваших изменений. -- **Issue/PR ссылки** - Укажите ссылки на предыдущую работу, которая связанна с вашим PR. Пожалуйста, опишите, как ваши изменения изменяют или расширяют эту работу. -- **Примеры** - Добавьте любые примеры или скриншоты, которые демонстрируют ваши изменения. -- **Черновик PRs** - Если ваши изменения не закончены, но вы хотели бы обсудить их, открыть PR как черновик и добавьте комментарии, чтобы начать обсуждение. Использование комментариев, а не PR описания позволяет обновить описание позже при сохранении любых обсуждений. - -## Ответы на вопросы - -> Я хочу внести свой вклад, с чего начать? - -Ознакомьтесь со списком [open issues for Task][task-open-issues] или [Task for Visual Studio Code][vscode-task-open-issues]. У нас есть лейбл [good first issue][good-first-issue] для простейших проблем, который идеально подходит для контрибьюторов, который первых вносят свой вклад. - -Приветствуются всевозможные вклады, будь то маленький фикс или новая функция. You can also contribute by upvoting/commenting on issues, helping to answer questions or contributing to other [community projects](/community). - -> Где можно получить помощь? - -Если у вас есть вопросы, не стесняйтесь спросить их в канале `#help` на нашем [Discord сервере][discord-server] или откройте [Discussion][discussion] на GitHub. - ---- - - - - -[task]: https://github.com/go-task/task -[vscode-task]: https://github.com/go-task/vscode-task -[go]: https://go.dev -[gofumpt]: https://github.com/mvdan/gofumpt -[golangci-lint]: https://golangci-lint.run -[prettier]: https://prettier.io -[nodejs]: https://nodejs.org/en/ -[yarn]: https://yarnpkg.com/ -[docusaurus]: https://docusaurus.io -[json-schema]: https://github.com/go-task/task/blob/main/docs/static/schema.json -[task-open-issues]: https://github.com/go-task/task/issues -[vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues -[good-first-issue]: https://github.com/go-task/task/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 -[discord-server]: https://discord.gg/6TY36E39UK -[discussion]: https://github.com/go-task/task/discussions -[conventional-commits]: https://www.conventionalcommits.org diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/deprecations/deprecations.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/deprecations/deprecations.md deleted file mode 100644 index 965b26d1..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/deprecations/deprecations.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: /deprecations/ -sidebar_position: 7 ---- - -# Deprecations - -As Task evolves, it occasionally outgrows some of its functionality. This can be because they are no longer useful, because another feature has replaced it or because of a change in the way that Task works internally. - -When this happens, we mark the functionality as deprecated. This means that it will be removed in a future version of Task. This functionality will continue to work until that time, but we strongly recommend that you do not implement this functionality in new Taskfiles and make a plan to migrate away from it as soon as possible. - -You can view a full list of active deprecations in the "Deprecations" section of the sidebar. diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/deprecations/template.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/deprecations/template.md deleted file mode 100644 index 646e45c6..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/deprecations/template.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Deprecated Feature\} (#\{Issue\}) - -:::warning - -This deprecation breaks the following functionality: - -- \{list any existing functionality that will be broken by this deprecation\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -\{Short description of the feature/behavior and why it is being deprecated\} - -\{Short explanation of any replacement features/behaviors and how users should migrate to it\} diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md deleted file mode 100644 index c45fb65d..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -slug: /deprecations/version-2-schema/ ---- - -# Version 2 Schema (#1197) - -:::warning - -This deprecation breaks the following functionality: - -- Any Taskfiles that use the version 2 schema -- `Taskvar.yml` files - -::: - -The Taskfile version 2 schema was introduced in March 2018 and replaced by version 3 in August 2019. In May 2023 [we published a deprecation notice][deprecation-notice] for the version 2 schema on the basis that the vast majority of users had already upgraded to version 3 and removing support for version 2 would allow us to tidy up the codebase and focus on new functionality instead. - -In December 2023, the final version of Task that supports the version 2 schema ([v3.33.0][v3.33.0]) was published and all legacy code was removed from Task's main branch. To use a more recent version of Task, you will need to ensure that your Taskfile uses the version 3 schema instead. A list of changes between version 2 and version 3 are available in the [Task v3 Release Notes][v3.0.0]. - - - - -[v3.0.0]: https://github.com/go-task/task/releases/tag/v3.0.0 -[v3.33.0]: https://github.com/go-task/task/releases/tag/v3.33.0 -[deprecation-notice]: https://github.com/go-task/task/issues/1197 diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/donate.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/donate.md deleted file mode 100644 index 9583bd2c..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/donate.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: /donate/ -sidebar_position: 16 ---- - -# Поддержать - -Если вам нравится этот проект, вы можете подумать о том, чтобы пожертвовать, используя один из способов, перечисленных ниже. - -Это просто способ сказать "спасибо", это не дает вам никаких преимуществ, таких как высший приоритет при рассмотрении проблем или что-то подобное. - -Компании, которые пожертвуют не менее $50 в месяц, будут представлены как "Золотые спонсоры" на главной странице сайта и в README репозитория на GitHub. Свяжитесь с [@andreynering][] и предоставьте ему нужный логотип. Подозрительные бизнесы (связанные с азартными играми, казино и т.д.) не будут допущены к спонсорству. - -## GitHub Sponsors - -Предпочтительный способ пожертвования для сопровождающих — через GitHub Sponsors. Just use the following links to do your donation. We suggest a 50/50 split to each maintainer of the total amount you plan to donate to the project. - -- [@andreynering](https://github.com/sponsors/andreynering) -- [@pd93](https://github.com/sponsors/pd93) - -## Open Collective - -Если вы предпочитаете [Open Collective](https://opencollective.com/task), вы можете пожертвовать используя следующие ссылки: - -- [$2 в месяц](https://opencollective.com/task/contribute/backer-4034/checkout) -- [$5 в месяц](https://opencollective.com/task/contribute/supporter-8404/checkout) -- [$20 в месяц](https://opencollective.com/task/contribute/sponsor-4035/checkout) -- [$50 в месяц](https://opencollective.com/task/contribute/sponsor-28775/checkout) -- [Любая сумма - Разовое пожертвование](https://opencollective.com/task/donate) - -## PayPal - -Вы можете сделать пожертвование [@andreynering][] через PayPal: - -- [Любая сумма - Разовое пожертвование](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GSVDU63RKG45A¤cy_code=USD&source=url) - -## PIX (только для Бразилии) - -Если вы из Бразилии, вы можете также пожертвовать [@andreynering][] через PIX [с помощью этого QR-кода](/img/pix.png). - - - - -[@andreynering]: https://github.com/andreynering diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/any_variables.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/any_variables.md deleted file mode 100644 index cf2521c7..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/any_variables.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables (#1415) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any -time_. We strongly recommend that you do not use these features in a production -environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- Dynamically defined variables (using the `sh` keyword) - -::: - -:::info - -To enable this experiment, set the environment variable: -`TASK_X_ANY_VARIABLES=1`. Check out [our guide to enabling experiments -][enabling-experiments] for more information. - -::: - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the [slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for "collection-type" variables, the `for` -keyword has been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -This also works for maps. When looping over a map we also make an additional -`{{.KEY}}` variable availabe that holds the string value of the map key. -Remember that maps are unordered, so the order in which the items are looped -over is random: - -```yaml -version: 3 - -tasks: - foo: - vars: - MAP: - KEY_1: - SUBKEY: sub_value_1 - KEY_2: - SUBKEY: sub_value_2 - KEY_3: - SUBKEY: sub_value_3 - cmds: - - for: - var: MAP - cmd: echo {{.KEY}} {{.ITEM.SUBKEY}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[enabling-experiments]: /experiments/#enabling-experiments - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx deleted file mode 100644 index 73cdcd80..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables - -- Issue: #1415 -- Environment variable: `TASK_X_ANY_VARIABLES=1` -- Breaks: - - Dynamically defined variables (using the `sh` keyword) - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the -[slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for array variables, the `for` keyword has -been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/experiments.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/experiments.md deleted file mode 100644 index b1a70473..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/experiments.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -slug: /experiments/ -sidebar_position: 6 ---- - -# Experiments - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -In order to allow Task to evolve quickly, we roll out breaking changes to minor versions behind experimental flags. This allows us to gather feedback on breaking changes before committing to a major release. This document describes the current set of experimental features and their status in the [workflow](#workflow). - -You can view a full list of active experiments in the "Experiments" section of the sidebar. - -## Enabling Experiments - -You can enable an experimental feature by doing one of the following: - -1. Using the relevant environment variable in front of a task command. For example, `TASK_X_{FEATURE}=1 task {my-task}`. This is intended for one-off invocations of Task to test out experimental features. -1. Using the relevant environment variable in your "dotfiles" (e.g. `.bashrc`, `.zshrc` etc.). This is intended for permanently enabling experimental features in your environment. -1. Creating a `.env` file in the same directory as your root Taskfile that contains the relevant environment variables. This allows you to enable an experimental feature at a project level. For example: - -```shell title=".env" -TASK_X_FEATURE=1 -``` - -## Current Experimental Features and Deprecations - -Each section below details an experiment or deprecation and explains what the flags/environment variables to enable the experiment are and how the feature's behavior will change. It will also explain what you need to do to migrate any existing Taskfiles to the new behavior. - -## Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -### 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -### 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -### 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -### 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -### 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -### Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/gentle_force.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/gentle_force.md deleted file mode 100644 index 514602bb..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/gentle_force.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -slug: /experiments/gentle-force/ ---- - -# Gentle Force (#1200) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- The `--force` flag - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_FORCE=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -The `--force` flag currently forces _all_ tasks to run regardless of the status checks. This can be useful, but we have found that most of the time users only expect the direct task they are calling to be forced and _not_ all of its dependant tasks. - -This experiment changes the `--force` flag to only force the directly called task. All dependant tasks will have their statuses checked as normal and will only run if Task considers them to be out of date. A new `--force-all` flag will also be added to maintain the current behavior for users that need this functionality. - -If you want to migrate, but continue to force all dependant tasks to run, you should replace all uses of the `--force` flag with `--force-all`. Alternatively, if you want to adopt the new behavior, you can continue to use the `--force` flag as you do now! - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md deleted file mode 100644 index 73a934d8..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -slug: /experiments/remote-taskfiles/ ---- - -# Remote Taskfiles (#1317) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_REMOTE_TASKFILES=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -This experiment allows you to specify a remote Taskfile URL when including a Taskfile. For example: - -```yaml -version: '3' - -includes: - my-remote-namespace: https://raw.githubusercontent.com/my-org/my-repo/main/Taskfile.yml -``` - -This works exactly the same way that including a local file does. Any tasks in the remote Taskfile will be available to run from your main Taskfile via the namespace `my-remote-namespace`. For example, if the remote file contains the following: - -```yaml -version: '3' - -tasks: - hello: - silent: true - cmds: - - echo "Hello from the remote Taskfile!" -``` - -and you run `task my-remote-namespace:hello`, it will print the text: "Hello from the remote Taskfile!" to your console. - -## Security - -Running commands from sources that you do not control is always a potential security risk. For this reason, we have added some checks when using remote Taskfiles: - -1. When running a task from a remote Taskfile for the first time, Task will print a warning to the console asking you to check that you are sure that you trust the source of the Taskfile. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the remote Taskfile will run and further calls to the remote Taskfile will not prompt you again. -2. Whenever you run a remote Taskfile, Task will create and store a checksum of the file that you are running. If the checksum changes, then Task will print another warning to the console to inform you that the contents of the remote file has changed. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the checksum will be updated and the remote Taskfile will run. - -Sometimes you need to run Task in an environment that does not have an interactive terminal, so you are not able to accept a prompt. In these cases you are able to tell task to accept these prompts automatically by using the `--yes` flag. Before enabling this flag, you should: - -1. Be sure that you trust the source and contents of the remote Taskfile. -2. Consider using a pinned version of the remote Taskfile (e.g. A link containing a commit hash) to prevent Task from automatically accepting a prompt that says a remote Taskfile has changed. - -Task currently supports both `http` and `https` URLs. However, the `http` requests will not execute by default unless you run the task with the `--insecure` flag. This is to protect you from accidentally running a remote Taskfile that is hosted on and unencrypted connection. Sources that are not protected by TLS are vulnerable to [man-in-the-middle attacks][man-in-the-middle-attacks] and should be avoided unless you know what you are doing. - -## Caching & Running Offline - -Whenever you run a remote Taskfile, the latest copy will be downloaded from the internet and cached locally. If for whatever reason, you lose access to the internet, you will still be able to run your tasks by specifying the `--offline` flag. This will tell Task to use the latest cached version of the file instead of trying to download it. You are able to use the `--download` flag to update the cached version of the remote files without running any tasks. - -By default, Task will timeout requests to download remote files after 10 seconds and look for a cached copy instead. This timeout can be configured by setting the `--timeout` flag and specifying a duration. For example, `--timeout 5s` will set the timeout to 5 seconds. - - - - -[enabling-experiments]: /experiments/#enabling-experiments -[man-in-the-middle-attacks]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/template.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/template.md deleted file mode 100644 index 59246cf5..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/template.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Experiment\} (#\{Issue\}) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- \{list any existing functionality that will be broken by this experiment\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_{feature}=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -\{Short description of the feature\} - -\{Short explanation of how users should migrate to the new behavior\} - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/workflow.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/workflow.md deleted file mode 100644 index 62aff616..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/experiments/workflow.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /experiments/workflow/ ---- - -# Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -## 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -## 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -## 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -## 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -## 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -## Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/faq.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/faq.md deleted file mode 100644 index 64a04bee..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/faq.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -slug: /faq/ -sidebar_position: 15 ---- - -# ЧАВО - -Эта страница содержит список часто задаваемых вопросов о Task. - -## Почему task не обновляет мои переменные среды оболочки? - -Это ограничение работы оболочек. Task запускается как подпроцесс вашей текущей оболочки, поэтому он не может сменить переменные среды оболочки, которая запустила его. Это ограничение есть и в других task runners и инструментах сборки тоже. - -Самый простой способ обойти это - создать задачу, генерирующую вывод, который может быть проанализирован вашей оболочкой. Например, чтобы установить переменные среды в вашей оболочке, вы можете написать task, похожую на: - -```yaml -my-shell-env: - cmds: - - echo "export FOO=foo" - - echo "export BAR=bar" -``` - -Теперь запустите `eval $(task my-shell-env)`, после этого переменные `$FOO` и `$BAR` будут доступны в вашей оболочке. - -## Я не могу переиспользовать свою оболочку в командах task's - -Task запускает каждую команду в качестве отдельного процесса оболочки, поэтому действия в одной команде не повлияют на другие команды. Например, это не сработает: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - a=foo - - echo $a - # outputs "" -``` - -Чтобы обойти это, вы можете использовать многострочную команду: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - | - a=foo - echo $a - # outputs "foo" -``` - -Или для более сложных многострочных команд рекомендуется перенести ваш код в отдельный файл, и вызвать его вместо команды: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - ./foo-printer.bash -``` - -```bash -#!/bin/bash -a=foo -echo $a -``` - -## 'x' builtin command doesn't work on Windows - -The default shell on Windows (`cmd` and `powershell`) do not have commands like `rm` and `cp` available as builtins. This means that these commands won't work. If you want to make your Taskfile fully cross-platform, you'll need to work around this limitation using one of the following methods: - -- Use the `{{OS}}` function to run an OS-specific script. -- Use something like `{{if eq OS "windows"}}powershell {{end}}` to detect windows and run the command in Powershell directly. -- Use a shell on Windows that supports these commands as builtins, such as [Git Bash][git-bash] or [WSL][wsl]. - -We want to make improvements to this part of Task and the issues below track this work. Constructive comments and contributions are very welcome! - -- #197 -- [mvdan/sh#93](https://github.com/mvdan/sh/issues/93) -- [mvdan/sh#97](https://github.com/mvdan/sh/issues/97) - - - - -[git-bash]: https://gitforwindows.org/ -[wsl]: https://learn.microsoft.com/en-us/windows/wsl/install diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/installation.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/installation.md deleted file mode 100644 index 70570491..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/installation.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -slug: /installation/ -sidebar_position: 2 ---- - -# Установка - -Task имеет множество способов установки. Просмотрите доступные методы ниже. - -## Менеджеры пакетов - -### Homebrew - -Если вы используете macOS или Linux и установили [Homebrew][homebrew], то для установки достаточно выполнить: - -```bash -brew install go-task/tap/go-task -``` - -The above Formula is [maintained by ourselves](https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb). - -Недавно Task стал доступен [в официальном репозитории Homebrew](https://formulae.brew.sh/formula/go-task), поэтому вы можете использовать: - -```bash -brew install go-task -``` - -### Tea - -If you're on macOS or Linux and have [tea][tea] installed, getting Task is as simple as running: - -```bash -tea task -``` - -or, if you have tea’s magic enabled: - -```bash -task -``` -Этот метод установки находится под управлением сообщества. After a new release of Task, they are automatically released by tea in a minimum of time. - -### Snap - -Task доступен в [Snapcraft][snapcraft], но имейте в виду, что ваш Linux дистрибутив должен иметь классическое ограничение для Snaps, чтобы Task работал правильно: - -```bash -sudo snap install task --classic -``` - -### Chocolatey - -Если вы используете Windows и у вас установлен [Chocolatey][choco], установка Task сводится к запуску: - -```bash -choco install go-task -``` - -Этот метод установки находится под управлением сообщества. - -### Scoop - -Если вы используете Windows и у вас установлен [Scoop][scoop], установка Task сводится к запуску: - -```cmd -scoop install task -``` - -This installation method is community owned. После нового релиза Task может потребоваться некоторое время, пока он станет доступен в Scoop. - -### AUR - -Если вы используете Arch Linux, вы можете установить Task из [AUR](https://aur.archlinux.org/packages/go-task-bin) с помощью вашего любимого менеджера пакетов, такого как `yay`, `pacaur` или `yaourt`: - -```cmd -yay -S go-task-bin -``` - -В качестве альтернативы, можно использовать [пакет](https://aur.archlinux.org/packages/go-task), который устанавливается из исходного кода, а не загружает бинарный файл со [страницы релизов](https://github.com/go-task/task/releases): - -```cmd -yay -S go-task -``` - -Этот метод установки находится под управлением сообщества. - -### Fedora - -Если вы используете Fedora Linux, вы можете установить Task из официального репозитория [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/), используя `dnf`: - -```cmd -sudo dnf install go-task -``` - -Этот метод установки находится под управлением сообщества. После нового релиза Task может потребоваться некоторое время, пока он станет доступен в [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/). - -### Nix - -Если вы используете NixOS или у вас установлен Nix, вы можете установить Task из [nixpkgs](https://github.com/NixOS/nixpkgs): - -```cmd -nix-env -iA nixpkgs.go-task -``` - -Этот метод установки находится под управлением сообщества. После нового релиза Task может потребоваться некоторое время, пока он станет доступен в [nixpkgs](https://github.com/NixOS/nixpkgs). - -### npm - -Для установки Task вы также можете использовать Node и npm, установив [этот пакет](https://www.npmjs.com/package/@go-task/cli). - -```bash -npm install -g @go-task/cli -``` - -### Winget - -Если вы используете Windows и установили менеджер пакетов [winget](https://github.com/microsoft/winget-cli), вы можете установить Task из [winget-pkgs](https://github.com/microsoft/winget-pkgs). - -```bash -winget install Task.Task -``` - -## Установка бинарных файлов - -### Бинарные - -Вы можете установить бинарные файлы со [страницы релизов на GitHub][releases] и добавить их в ваш `$PATH`. - -Также доступны DEB и RPM пакеты. - -Файл `task_checksums.txt` содержит контрольные суммы SHA-256 для каждого файла. - -### Скрипт для установки - -У нас также есть [скрипт для установки][installscript], который очень полезен в некоторых случаях, таких как CI. Благодарим [GoDownloader][godownloader] за то, что он облегчает генерацию этого скрипта. - -По умолчанию он устанавливается в каталог `./bin` относительно рабочего каталога: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -``` - -Вы можете переопределить каталог установки с помощью параметра `-b`. В Linux распространенными вариантами являются `~/.local/bin` и `~/bin`, чтобы установить для текущего пользователя, или `/usr/local/bin`, чтобы установить для всех пользователей: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin -``` - -:::caution - -В macOS и Windows, `~/.local/bin` и `~/bin` по умолчанию не добавляются в `$PATH`. - -::: - -### GitHub Actions - -Если вы хотите установить Task в GitHub Actions, вы можете попробовать использовать [это действие](https://github.com/arduino/setup-task) от команды Arduino: - -```yaml -- name: Install Task - uses: arduino/setup-task@v1 - with: - version: 3.x - repo-token: ${{ secrets.GITHUB_TOKEN }} -``` - -This installation method is community owned. - -## Сборка из исходного кода - -### Go Modules - -Убедитесь, что у вас правильно установлена и настроена поддерживаемая версия [Go][go]. Вы можете найти минимальную требуемую версию Go в [go.mod](https://github.com/go-task/task/blob/main/go.mod#L3) файле. - -Затем вы можете установить последнюю версию глобально, запустив: - -```bash -go install github.com/go-task/task/v3/cmd/task@latest -``` - -Или вы можете установить в другую директорию: - -```bash -env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest -``` - -:::tip - -Для окружения CI мы рекомендуем вместо этого использовать [скрипт установки](#install-script), который быстрее и стабильнее, так как он просто загрузит последний выпущенный бинарный файл. - -::: - -## Завершение установки - -Загрузите файл автодополнения, соответствующий вашей оболочке. - -[Все дополнения доступны в репозитории Task](https://github.com/go-task/task/tree/main/completion). - -### Bash - -Сначала убедитесь, что вы установили bash-completion с помощью вашего менеджера пакетов. - -Сделайте файл автодополнения исполняемым: - -``` -chmod +x path/to/task.bash -``` - -Затем, добавьте это в свой `~/.bash_profile`: - -```shell -source path/to/task.bash -``` - -### ZSH - -Поместите файл `_task` куда-нибудь в ваш `$FPATH`: - -```shell -mv path/to/_task /usr/local/share/zsh/site-functions/_task -``` - -Убедитесь, что в `~/.zshrc` присутствует следующее: - -```shell -autoload -U compinit -compinit -i -``` - -Рекомендуется использовать ZSH версии 5.7 или выше. - -### Fish - -Переместите скрипт автодополнения `task.fish`: - -```shell -mv path/to/task.fish ~/.config/fish/completions/task.fish -``` - -### PowerShell - -Откройте сценарии вашего профиля с помощью: - -``` -mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue -notepad $profile -``` - -Добавьте строку и сохраните файл: - -```shell -Invoke-Expression -Command path/to/task.ps1 -``` - - - - -[go]: https://golang.org/ -[snapcraft]: https://snapcraft.io/task -[homebrew]: https://brew.sh/ -[installscript]: https://github.com/go-task/task/blob/main/install-task.sh -[releases]: https://github.com/go-task/task/releases -[godownloader]: https://github.com/goreleaser/godownloader -[choco]: https://chocolatey.org/ -[scoop]: https://scoop.sh/ -[tea]: https://tea.xyz/ diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/integrations.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/integrations.md deleted file mode 100644 index 4ac94735..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/integrations.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -slug: /integrations/ -sidebar_position: 8 ---- - -# Интеграции - -## Расширение для Visual Studio Code - -У Task есть официальное расширение для [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task). Код для этого проекта можно найти [здесь](https://github.com/go-task/vscode-task). Чтобы использовать это расширение, на вашей системе должна быть установлена версия Task 3.23.0+. - -Это расширение предоставляет следующие функции: - -- Просмотр задач в боковой панели. -- Запуск задач из боковой панели и командной строки. -- Перейти к определению из боковой панели и командной строки. -- Выполнить последнюю "task" команду. -- Поддержка нескольких рабочих пространств. -- Инициализировать Taskfile в текущем рабочем пространстве. - -Чтобы включить автозаполнение и проверку вашего Taskfile, см. раздел [Схема](#schema) ниже. - -![Task for Visual Studio Code](https://github.com/go-task/vscode-task/blob/main/res/preview.png?raw=true) - -## Схема - -This was initially created by @KROSF in [this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and is now officially maintained in [this file](https://github.com/go-task/task/blob/main/docs/static/schema.json) and made available at https://taskfile.dev/schema.json. Эта схема может быть использована для проверки Task файлов и автодополнения во многих редакторах кода: - -### Visual Studio Code - -Чтобы интегрировать схему в VS Code, вам нужно установить [YAML расширение](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) от Red Hat. Любой `Taskfile.yml` в вашем проекте должен автоматически быть обнаружен и валидирован/автодополнение должен работать. Если это не работает или вы хотите настроить его вручную для файлов с другим именем, вы можете добавить следующие в `settings.json`: - -```json -// settings.json -{ - "yaml.schemas": { - "https://taskfile.dev/schema.json": [ - "**/Taskfile.yml", - "./path/to/any/other/taskfile.yml" - ] - } -} -``` - -Вы также можете настроить схему непосредственно внутри Taskfile, добавив следующий комментарий в начале файла: - -```yaml -# yaml-language-server: $schema=https://taskfile.dev/schema.json -version: '3' -``` - -Вы можете найти дополнительную информацию об этом в [YAML language server project](https://github.com/redhat-developer/yaml-language-server). - -## Интеграции сообщества - -В дополнение к нашей официальной интеграции, сообщество разработчиков разработало свои собственные интеграции для Task: - -- [Sublime Text Plugin](https://packagecontrol.io/packages/Taskfile) [[source](https://github.com/biozz/sublime-taskfile)] by @biozz -- [IntelliJ Plugin](https://plugins.jetbrains.com/plugin/17058-taskfile) [[source](https://github.com/lechuckroh/task-intellij-plugin)] by @lechuckroh -- [mk](https://github.com/pycontribs/mk) - инструмент командной строки распознает Taskfile'ы. - -Если вы сделали что-то, что интегрируется с Task, пожалуйста, не стесняйтесь открыть PR, чтобы добавить его в этот список. diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/intro.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/intro.md deleted file mode 100644 index d85cf1c6..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/intro.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -slug: / -sidebar_position: 1 -title: Home ---- - -# Task - -
- -
- -Task - это инструмент для запуска / сборки, который стремится быть простым и удобным в использовании, чем, например, [GNU Make][make]. - -Так как Task написан на [Go][go], он представляет собой единственный исполняемый файл и не имеет других зависимостей, что означает, что вам не нужно заниматься сложной настройкой установки просто для использования инструмента сборки. - -Once [installed](/installation), you just need to describe your build tasks using a simple [YAML][yaml] schema in a file called `Taskfile.yml`: - -```yaml title="Taskfile.yml" -version: '3' - -tasks: - hello: - cmds: - - echo 'Hello World from Task!' - silent: true -``` - -И вызвать ее, запустив `task hello` в вашем терминале. - -Приведенный выше пример - это только начало, вы можете посмотреть на [руководство](/usage) по использованию, чтобы посмотреть полную документацию схемы и функций Task. - -## Features - -- [Easy installation](/installation): just download a single binary, add to `$PATH` and you're done! Или вы можете установить с помощью [Homebrew][homebrew], [Snapcraft][snapcraft] или [Scoop][scoop], если хотите. -- Available on CIs: by adding [this simple command](/installation#install-script) to install on your CI script and you're ready to use Task as part of your CI pipeline; -- Полностью кроссплатформенный: в то время как большинство инструментов сборки хорошо работают только в Linux или macOS, Task также поддерживает Windows, благодаря [интерпретатору командной оболочки для Go][sh]. -- Отлично подходит для кодогенерации: вы можете легко [предотвратить запуск задачи](/usage#prevent-unnecessary-work), если необходимый набор файлов не изменился с прошлого запуска (основываясь на времени изменения или содержимом). - - - - -[make]: https://www.gnu.org/software/make/ -[go]: https://go.dev/ -[yaml]: http://yaml.org/ -[homebrew]: https://brew.sh/ -[snapcraft]: https://snapcraft.io/ -[scoop]: https://scoop.sh/ -[sh]: https://github.com/mvdan/sh diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/releasing.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/releasing.md deleted file mode 100644 index 3379b54e..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/releasing.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /releasing/ -sidebar_position: 13 ---- - -# Релизы - -Процесс выпуска новой версии Task осуществляется с помощью [GoReleaser][goreleaser]. Вы можете протестировать процесс релиза новой версии локального, вызвав задачу `test-release` в Taskfile. - -[GitHub Actions](https://github.com/go-task/task/actions) должны автоматически выпускать артефакты, когда создаётся новый Git-тег в `main` ветке (сырые исполняемые файлы и пакеты DEB и RPM). - -Начиная с версии 3.15. сырые, необработанные исполняемые файлы также могут быть воспроизведены и проверены локально путем проверки конкретного тега и вызова `goreleaser build`, используя версию Go, определенную в GitHub Actions. - -# Homebrew - -Goreleaser will automatically push a new commit to the [Formula/go-task.rb][gotaskrb] file in the [Homebrew tap][homebrewtap] repository to release the new version. - -# npm - -Для выпуска npm обновите версию пакета в файле [`package.json`][packagejson] и затем выполнить `задачу npm:publish`, чтобы опубликовать его. - -# Snapcraft - -Для выпуска новой версии [Snap пакета][snappackage] необходимо: - -- Updating the current version on [snapcraft.yaml][snapcraftyaml]. -- Переместить `amd64`, `armhf` и `arm64` артефакты в стабильный канал на панели [Snapcraft][snapcraftdashboard]. - -# winget - -winget also requires manual steps to be completed. By running `task goreleaser:test` locally, manifest files will be generated on `dist/winget/manifests/t/Task/Task/v{version}`. [Upload the manifest directory into this fork](https://github.com/go-task/winget-pkgs/tree/master/manifests/t/Task/Task) and open a pull request into [this repository](https://github.com/microsoft/winget-pkgs). - -# Scoop - -Scoop - это менеджер пакетов командной строки для операционной системы Windows. Сообщество поддерживает манифесты пакета Scoop. Владельцы Scoop обычно заботятся об обновлении версий, редактируя [этот файл](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json). If you think its Task version is outdated, open an issue to let us know. - -# Nix - -Nix - это метод установки, принадлежащий сообществу. Мейнтейнеры Nix пакетов позаботились об обновлении версий, редактируя [этот файл](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/development/tools/go-task/default.nix). Если вы считаете, что его версия Task устарела, откройте issue, чтобы уведомить нас. - - - - -[goreleaser]: https://goreleaser.com/ -[homebrewtap]: https://github.com/go-task/homebrew-tap -[gotaskrb]: https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb -[packagejson]: https://github.com/go-task/task/blob/main/package.json#L3 -[snappackage]: https://github.com/go-task/snap -[snapcraftyaml]: https://github.com/go-task/snap/blob/main/snap/snapcraft.yaml#L2 -[snapcraftdashboard]: https://snapcraft.io/task/releases diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/styleguide.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/styleguide.md deleted file mode 100644 index 5d4a5267..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/styleguide.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -slug: /styleguide/ -sidebar_position: 10 ---- - -# Стайлгайд - -Это официальный стайлгайд Task для `Taskfile.yml` файлов. Это руководство содержит некоторые базовые инструкции для того, чтобы ваш Taskfile был чистым и понятен другим пользователям. - -Этот стайлгайд содержит общие рекомендации по написанию кода, но не обязательно требует их строгого соблюдения. Можете не соглашаться с правилами и использовать другой подход, если вам это нужно или хотите это сделать. Кроме того, не стесняйтесь создавать Issue или PR с улучшениями этого гида. - -## Используйте правильный порядок ключевых слов - -- `version:` -- `includes:` -- Конфигурационные параметры, такие как `output:`, `silent:`, `method:` и `run:` -- `vars:` -- `env:`, `dotenv:` -- `tasks:` - -## Используйте 2 пробела для отступа - -Это наиболее распространенное соглашение для YAML-файлов, и Task следует ему. - -```yaml -# bad -tasks: - foo: - cmds: - - echo 'foo' - - -# good -tasks: - foo: - cmds: - - echo 'foo' -``` - -## Разделяйте основные секции пробелами - -```yaml -# bad -version: '3' -includes: - docker: ./docker/Taskfile.yml -output: prefixed -vars: - FOO: bar -env: - BAR: baz -tasks: - # ... - - -# good -version: '3' - -includes: - docker: ./docker/Taskfile.yml - -output: prefixed - -vars: - FOO: bar - -env: - BAR: baz - -tasks: - # ... -``` - -## Добавляйте пробелы между задачами - -```yaml -# bad -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - bar: - cmds: - - echo 'bar' - baz: - cmds: - - echo 'baz' - - -# good -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - - bar: - cmds: - - echo 'bar' - - baz: - cmds: - - echo 'baz' -``` - -## Используйте имена переменных в верхнем регистре - -```yaml -# bad -version: '3' - -vars: - binary_name: myapp - -tasks: - build: - cmds: - - go build -o {{.binary_name}} . - - -# good -version: '3' - -vars: - BINARY_NAME: myapp - -tasks: - build: - cmds: - - go build -o {{.BINARY_NAME}} . -``` - -## Не заключайте переменные в пробелы при использовании их в шаблонах - -```yaml -# bad -version: '3' - -tasks: - greet: - cmds: - - echo '{{ .MESSAGE }}' - - -# good -version: '3' - -tasks: - greet: - cmds: - - echo '{{.MESSAGE}}' -``` - -Большинство людей использует это соглашение и для любых шаблонов в Go. - -## Разделяйте слова в названии задач дефисом - -```yaml -# bad -version: '3' - -tasks: - do_something_fancy: - cmds: - - echo 'Do something' - - -# good -version: '3' - -tasks: - do-something-fancy: - cmds: - - echo 'Do something' -``` - -## Используйте двоеточие для неймспейсов в названиях задач - -```yaml -# good -version: '3' - -tasks: - docker:build: - cmds: - - docker ... - - docker:run: - cmds: - - docker-compose ... -``` - -Это также происходит автоматически при использовании включенных Taskfiles. - -## Prefer external scripts over complex multi-line commands - -```yaml -# bad -version: '3' - -tasks: - build: - cmds: - - | - for i in $(seq 1 10); do - echo $i - echo "some other complex logic" - done' - -# good -version: '3' - -tasks: - build: - cmds: - - ./scripts/my_complex_script.sh -``` diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/taskfile_versions.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/taskfile_versions.md deleted file mode 100644 index 1d23467d..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/taskfile_versions.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -slug: /taskfile-versions/ -sidebar_position: 5 ---- - -# Версии Taskfile - -Синтаксис Taskfile и функции со временем изменяются. Этот документ объясняет, что изменилось в каждой версии и как обновить свой Taskfile. - -## Что обозначает версия Taskfile - -Версия Taskfile соответствует версии Task. Например: изменение на Taskfile версии `2` означает, что Task `v2.0.0` должна быть выпущена для ее поддержки. - -`version:` ключ Taskfile принимает [semVer](https://semver.org/lang/ru/) строку. Пример: `2`, `2.0` или `2.0.0`. Если вы решите использовать Task версии `2.0`, то у вас не будет доступа к функциям версии `2.1`, но если вы решите использовать версию `2`, то любые функции версий `2.x.x` будут доступны, но не `3.0.0+`. - -## Version 3 ![latest](https://img.shields.io/badge/latest-brightgreen) - -Основные изменения, сделанные в `v3`: - -- Output задачи теперь цветной -- Добавлена поддержка `.env` файлов -- Добавлен параметр `label:`. Появилась возможность переопределить имя задачи в логах -- Глобальный параметр `method:` был добавлен для установки метода по умолчанию, а задача по умолчанию изменена на `checksum` -- Two magic variables were added when using `status:`: `CHECKSUM` and `TIMESTAMP` which contains, respectively, the XXH3 checksum and greatest modification timestamp of the files listed on `sources:` -- Кроме того, переменная `TASK` всегда доступна по имени текущей задачи -- Переменные CLI всегда считаются глобальными переменными -- Добавлена опция `dir:` в `includes` для того, чтобы выбрать, в каком каталоге Taskfile будет запущен: - -```yaml -includes: - docs: - taskfile: ./docs - dir: ./docs -``` - -- Реализован короткий синтаксис задачи. Все синтаксисы ниже эквивалентны: - -```yaml -version: '3' - -tasks: - print: - cmds: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: echo "Hello, World!" -``` - -- Был произведён большой рефакторинг обработки переменных. Теперь всё стало более прозрачно. The `expansions:` setting was removed as it became unnecessary. Это порядок, в котором Task будет обрабатывать переменные, каждый уровень может видеть переменные, объявленные на предыдущем и переопределять их. - - Переменные окружения - - Глобальные + CLI переменные - - Вызов переменных - - Переменные Task - -## Версия 2.6 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Версия 2.6 поставляется с `preconditions` опцией в задачах. - -```yaml -version: '2' - -tasks: - upload_environment: - preconditions: - - test -f .env - cmds: - - aws s3 cp .env s3://myenvironment -``` - -Please check the [documentation][includes] - -## Версия 2.2 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -В Версии 2.2 появилась новая глобальная опция `includes`, которая позволяет импортировать другие Taskfile'ы: - -```yaml -version: '2' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -## Версия 2.1 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.1 includes a global `output` option, to allow having more control over how commands output are printed to the console (see [documentation][output] for more info): - -```yaml -version: '2' - -output: prefixed - -tasks: - server: - cmds: - - go run main.go - prefix: server -``` - -From this version it's also possible to ignore errors of a command or task (check documentation [here][ignore_errors]): - -```yaml -version: '2' - -tasks: - example-1: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "This will be print" - - example-2: - cmds: - - exit 1 - - echo "This will be print" - ignore_error: true -``` - -## Версия 2.0 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -В версии 2 был добавлен ключ `version: `. Он позволяет выпускать обновления сохраняя обратную совместимость. Пример использования: - -```yaml -version: '2' - -tasks: - echo: - cmds: - - echo "Hello, World!" -``` - -Версия 2 позволяет создавать глобальные переменные непосредственно в Taskfile, если вы не хотите создавать `Taskvars.yml`: - -```yaml -version: '2' - -vars: - GREETING: Hello, World! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -Порядок приоритетов переменных также отличается: - -1. Переменные Task -2. Call variables -3. Переменные Taskfile -4. Переменные `Taskvars.yml` -5. Environment variables - -Добавлена новая глобальная опция для настройки количества расширений переменных (по умолчанию 2): - -```yaml -version: '2' - -expansions: 3 - -vars: - FOO: foo - BAR: bar - BAZ: baz - FOOBAR: '{{.FOO}}{{.BAR}}' - FOOBARBAZ: '{{.FOOBAR}}{{.BAZ}}' - -tasks: - default: - cmds: - - echo "{{.FOOBARBAZ}}" -``` - -## Версия 1 - -:::caution - -v1 schema support was removed in Task >= v3.0.0. - -::: - -В первой версии `Taskfile` поле `version:` не доступно, потому что задачи были в корне документа YAML. Пример: - -```yaml -echo: - cmds: - - echo "Hello, World!" -``` - -Порядок приоритетов переменных также отличается: - -1. Call variables -2. Переменные среды -3. Переменные Task -4. Переменные `Taskvars.yml` - - - - -[deprecate-version-2-schema]: /deprecations/version-2-schema/ -[output]: /usage#output-syntax -[ignore_errors]: /usage#ignore-errors -[includes]: /usage#including-other-taskfiles diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/translate.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/translate.md deleted file mode 100644 index c55bb12d..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/translate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -slug: /translate/ -sidebar_position: 12 ---- - -# Перевод - -Хотите помочь нам перевести эту документацию? В этом документе мы объясним каким образом. - -НЕ редактируйте переведенные файлы markdown прямо в репозитории GitHub! Мы используем [Crowdin][crowdin], чтобы позволить участникам работать над переводами. Репозиторий периодически обновляется с прогрессом из Crowdin. - -Если вы хотите получить доступ к проекту Crowdin, чтобы предложить перевод, пожалуйста, попросите доступ к каналу [#translations на нашем Discord сервере][discord]. Если данный язык еще не отображается в Crowdin, просто спросите и мы сможем его настроить. - - - - -[crowdin]: https://crowdin.com/project/taskfile -[discord]: https://discord.gg/6TY36E39UK diff --git a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/usage.md b/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/usage.md deleted file mode 100644 index 1e6a914f..00000000 --- a/docs/i18n/ru-RU/docusaurus-plugin-content-docs/current/usage.md +++ /dev/null @@ -1,1624 +0,0 @@ ---- -slug: /usage/ -sidebar_position: 3 ---- - -# Использование - -## Начало работы - -Создайте файл с именем `Taskfile.yml` в корне вашего проекта. Атрибут `cmds` должен содержать команды задачи. Пример ниже позволяет скомпилировать приложение Go и использовать [esbuild](https://esbuild.github.io/) чтобы собрать и минимизировать несколько CSS файлов в один. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -Запуск задач настолько прост, что достаточно выполнить команду: - -```bash -task assets build -``` - -Task использует [mvdan.cc/sh](https://mvdan.cc/sh/) - нативный интерпретатор sh на Go. Таким образом, вы можете писать команды sh / bash, и они будут работать даже в Windows, где обычно не доступны `sh` или `bash`. Просто помните, что любой исполняемый файл, который вызывается, должен быть доступен ОС или находиться в переменной PATH. - -Если вы опустите имя задачи, то будет использоваться имя "default". - -## Поддерживаемые названия файлов - -Task будет искать следующие файлы, в порядке приоритета: - -- Taskfile.yml -- taskfile.yml -- Taskfile.yaml -- taskfile.yaml -- Taskfile.dist.yml -- taskfile.dist.yml -- Taskfile.dist.yaml -- taskfile.dist.yaml - -Идея создания вариантов `.dist` заключается в том, чтобы позволить проектам иметь одну фиксированную версию (`.dist`), при этом позволяя отдельным пользователям переопределить Taskfile, добавив дополнительный `Taskfile.yml` (который будет находится в `.gitignore`). - -### Запуск Taskfile из поддиректории - -Если Taskfile не найден в текущем рабочем каталоге, он будет искать его вверх по дереву файлов, пока не найдет его (похоже на то, как работает `git`). При запуске Task из подкаталога, он будет работать так, как будто вы запустили его из каталога, содержащего Taskfile. - -Вы можете использовать эту функцию вместе со специальной переменной `{{.USER_WORKING_DIR}}`, чтобы создавать переиспользуемые задачи. Например, если у вас есть монорепозиторий с каталогами для каждого микросервиса, вы можете `cd` в директорию микросервиса и запустить команду задачи, без создания нескольких задач или Taskfile с идентичным содержимым. Например: - -```yaml -version: '3' - -tasks: - up: - dir: '{{.USER_WORKING_DIR}}' - preconditions: - - test -f docker-compose.yml - cmds: - - docker-compose up -d -``` - -В этом примере мы можем выполнить `cd ` и `task up`, и при условии, что каталог `` содержит файл `docker-compose.yml`, Docker composition будет запущен. - -### Запуск глобального Taskfile - -Если вы вызовите Task с помощью флага `--global` (псевдоним `-g`), будет искать ваш домашний каталог вместо рабочего каталога. In short, Task will look for a Taskfile that matches `$HOME/{T,t}askfile.{yml,yaml}` . - -Это полезно, чтобы иметь автоматизацию, которую можно запустить из любого места вашей системы! - -:::info - -Когда вы запускаете ваш глобальный Taskfile с помощью `-g`, task будут выполняться по умолчанию в директории `$HOME`, а не в вашей рабочей директории! - -Как упоминалось в предыдущем разделе, специальная переменная `{{.USER_WORKING_DIR}}` может быть очень полезной для запуска команд в директории, из которой вы вызываете `task -g`. - -```yaml -version: '3' - -tasks: - from-home: - cmds: - - pwd - - from-working-directory: - dir: '{{.USER_WORKING_DIR}}' - cmds: - - pwd -``` - -::: - -## Переменные среды - -### Task - -Вы можете использовать `env` для создания своих переменных среды для конкретной task: - -```yaml -version: '3' - -tasks: - greet: - cmds: - - echo $GREETING - env: - GREETING: Hey, there! -``` - -Также, вы можете создавать глобальные переменные окружения, которые будут доступны всем task: - -```yaml -version: '3' - -env: - GREETING: Hey, there! - -tasks: - greet: - cmds: - - echo $GREETING -``` - -:::info - -`env` поддерживает дополнение и извлечение вывода из команды shell или переменной, вы можете посмотреть в разделе [Переменные](#variables). - -::: - -### .env файлы - -Вы также можете попросить Task включать файлы, подобные `.env` используя настройку `dotenv:`: - -```bash title=".env" -KEYNAME=VALUE -``` - -```bash title="testing/.env" -ENDPOINT=testing.com -``` - -```yaml title="Taskfile.yml" -version: '3' - -env: - ENV: testing - -dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - -tasks: - greet: - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Dotenv файлы также могут быть указаны на уровне task: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Переменные окружения, определенные на уровне task, заменят переменные объявленные в dotenv файлах: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - env: - KEYNAME: DIFFERENT_VALUE - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -:::info - -Обратите внимание, в данный момент вы не можете использовать ключ `dotenv` во вложенных Taskfile. - -::: - -## Включение других Taskfile - -Если вы хотите использовать task в других проектах (Taskfile), вы можете использовать механизм импорта для включения других Taskfile используя ключевое слово `includes`: - -```yaml -version: '3' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -Task, описанные в указанных Taskfile, будут доступны с указанным пространством имен. Таким образом, вы можете запустить `serve` task из файла `documentation/Taskfile.yml` с помощью команды `task docs:serve`, или запустить `build` task из файла `DockerTasks.yml` с помощью команды `task docker:build`. - -Относительные пути разрешаются относительно каталога, содержащего включающий Taskfile. - -### Специфичные для ОС Taskfile - -С помощью `version: '2'` task автоматически включает любой `Taskfile_{{OS}}.yml`, если такой файл существует (например: `Taskfile_windows.yml`, `Taskfile_linux.yml` или `Taskfile_darwin.yml`). Так как такое поведение было несколько неявным, оно было удалено в версии 3. Тем не менее можно получить схожее поведение, явно импортировав соответствующие файлы: - -```yaml -version: '3' - -includes: - build: ./Taskfile_{{OS}}.yml -``` - -### Директория включенного Taskfile - -По умолчанию task включенного Taskfile выполняются в текущем каталоге, даже если Taskfile находится в другом каталоге, но вы можете заставить задачи выполняться в другом каталоге, используя альтернативный синтаксис: - -```yaml -version: '3' - -includes: - docs: - taskfile: ./docs/Taskfile.yml - dir: ./docs -``` - -:::info - -Включенные Taskfile должны использовать ту же версию схемы, что и основной Taskfile. - -::: - -### Опциональные включения - -Включения, отмеченные как необязательные, позволяют Task продолжать выполнение в нормальном режиме, если включенный файл отсутствует. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./tests/Taskfile.yml - optional: true - -tasks: - greet: - cmds: - - echo "This command can still be successfully executed if - ./tests/Taskfile.yml does not exist" -``` - -### Внутренние включения - -Включения, отмеченные как internal, устанавливают также все задачи включенного файла как internal (см. секцию [Внутренние task](#внутренние-task) ниже). Это полезно, когда включаются утилитарные task, которые не предназначены для прямого использования пользователем. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./taskfiles/Utils.yml - internal: true -``` - -### Переменные включенных Taskfile - -Вы также можете указывать переменные при включении Taskfile. Это может быть полезно для создания переиспользуемого Taskfile, который можно настроить или даже включать более одного раза: - -```yaml -version: '3' - -includes: - backend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: backend_image - - frontend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: frontend_image -``` - -### Псевдонимы пространств имен - -При включении Taskfile, вы можете дать пространству имен список `aliases`. Это работает так же, как и [псевдонимы task](#псевдонимы-task) и может использоваться вместе, чтобы создавать более короткие и легко набираемые команды. - -```yaml -version: '3' - -includes: - generate: - taskfile: ./taskfiles/Generate.yml - aliases: [gen] -``` - -:::info - -Переменные, объявленные во включенном Taskfile, имеют приоритет над переменными включающего Taskfile! Если вы хотите, чтобы переменную включенного Taskfile можно было переопределить, используйте [функцию default](https://go-task.github.io/slim-sprig/defaults.html): `MY_VAR: '{{.MY_VAR | default "my-default-value"}}'`. - -::: - -## Внутренние task - -Внутренние task - это task, которые не могут быть вызваны напрямую пользователем. Они не будут отображаться в выводе при вызове команды `task --list|--list-all`. Другие task могут вызывать внутренние задачи обычным способом. Это полезно для создания переиспользуемых task, похожих на функции, которые не имеют практического значения при выполнении в командной строке. - -```yaml -version: '3' - -tasks: - build-image-1: - cmds: - - task: build-image - vars: - DOCKER_IMAGE: image-1 - - build-image: - internal: true - cmds: - - docker build -t {{.DOCKER_IMAGE}} . -``` - -## Директория task - -По умолчанию, task выполняются в директории, где находится Taskfile. Но вы можете легко заставить task выполниться в другом каталоге, указав `dir`: - -```yaml -version: '3' - -tasks: - serve: - dir: public/www - cmds: - # run http server - - caddy -``` - -Если директории не существует, `task` создаст ее. - -## Зависимости task - -> Зависимости выполняются параллельно, поэтому зависимости task не должны зависеть друг от друга. Если вы хотите принудительно запустить задачи последовательно, обратите внимание на раздел [Вызов другой task](#вызов-другой-task), описанный ниже. - -У вас могут быть task, которые зависят от других. Просто перечислите их в списке `deps`, и они будут автоматически запущены перед запуском родительской task: - -```yaml -version: '3' - -tasks: - build: - deps: [assets] - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -В примере выше, `assets` будет всегда запускаться перед `build`, если вы запустите `task build`. - -Task может иметь зависимости без команд, чтобы группировать задачи вместе: - -```yaml -version: '3' - -tasks: - assets: - deps: [js, css] - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -Если есть более одной зависимости, то они всегда выполняются параллельно для лучшей производительности. - -:::tip - -Вы также можете запустить несколько task, указанные в командной строке, параллельно, используя флаг `--parallel` (псевдоним `-p`). Например: `task --parallel js css`. - -::: - -Если вы хотите передать информацию зависимостям, вы можете сделать это таким же образом, как и при [вызове другой task](#вызов-другой-task): - -```yaml -version: '3' - -tasks: - default: - deps: - - task: echo_sth - vars: { TEXT: 'before 1' } - - task: echo_sth - vars: { TEXT: 'before 2' } - silent: true - cmds: - - echo "after" - - echo_sth: - cmds: - - echo {{.TEXT}} -``` - -## Платформно-зависимые tasks и команды - -Если вы хотите ограничить запуск tasks определенными платформами, вы можете сделать это используя ключ `platforms:`. Tasks могут быть ограничены определенной ОС, архитектурой или комбинацией этих элементов. В случае несоответствия, task или команда будут пропущены, и ошибка не вернется. - -Разрешенные значения ОС и архитектур или `GOOS` и `GOARCH` определены языком Go [здесь](https://github.com/golang/go/blob/master/src/go/build/syslist.go). - -Task ниже `build-windows` будет выполняться только на Windows любой архитектуры: - -```yaml -version: '3' - -tasks: - build-windows: - platforms: [windows] - cmds: - - echo 'Running command on Windows' -``` - -Это можно ограничить определенной архитектурой следующим образом: - -```yaml -version: '3' - -tasks: - build-windows-amd64: - platforms: [windows/amd64] - cmds: - - echo 'Running command on Windows (amd64)' -``` - -Также можно ограничить task определенными архитектурами: - -```yaml -version: '3' - -tasks: - build-amd64: - platforms: [amd64] - cmds: - - echo 'Running command on amd64' -``` - -Несколько платформ можно указать так: - -```yaml -version: '3' - -tasks: - build: - platforms: [windows/amd64, darwin] - cmds: - - echo 'Running command on Windows (amd64) and macOS' -``` - -Отдельные команды также могут быть ограничены определенными платформами: - -```yaml -version: '3' - -tasks: - build: - cmds: - - cmd: echo 'Running command on Windows (amd64) and macOS' - platforms: [windows/amd64, darwin] - - cmd: echo 'Running on all platforms' -``` - -## Вызов другой task - -Когда task имеет много зависимостей, они выполняются параллельно. Это частно приводит к более быстрому построению пайплайна. Однако, в некоторых ситуациях вам может понадобиться вызвать другие task последовательно. В этом случае используйте следующий синтаксис: - -```yaml -version: '3' - -tasks: - main-task: - cmds: - - task: task-to-be-called - - task: another-task - - echo "Both done" - - task-to-be-called: - cmds: - - echo "Task to be called" - - another-task: - cmds: - - echo "Another task" -``` - -Используя атрибуты `vars` и `silent`, вы можете выбирать, передавать ли переменные и включать или выключать [silent mode](#silent-mode) для вызова каждый раз отдельно: - -```yaml -version: '3' - -tasks: - greet: - vars: - RECIPIENT: '{{default "World" .RECIPIENT}}' - cmds: - - echo "Hello, {{.RECIPIENT}}!" - - greet-pessimistically: - cmds: - - task: greet - vars: { RECIPIENT: 'Cruel World' } - silent: true -``` - -Указанный выше синтаксис также поддерживается в `deps`. - -:::tip - -NOTE: If you want to call a task declared in the root Taskfile from within an [included Taskfile](#including-other-taskfiles), add a leading `:` like this: `task: :task-name`. - -::: - -## Prevent unnecessary work - -### By fingerprinting locally generated files and their sources - -If a task generates something, you can inform Task the source and generated files, so Task will prevent running them if not necessary. - -```yaml -version: '3' - -tasks: - build: - deps: [js, css] - cmds: - - go build -v -i main.go - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - sources: - - src/js/**/*.js - generates: - - public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css - sources: - - src/css/**/*.css - generates: - - public/bundle.css -``` - -`sources` and `generates` can be files or glob patterns. When given, Task will compare the checksum of the source files to determine if it's necessary to run the task. If not, it will just print a message like `Task "js" is up to date`. - -`exclude:` can also be used to exclude files from fingerprinting. Sources are evaluated in order, so `exclude:` must come after the positive glob it is negating. - -```yaml -version: '3' - -tasks: - css: - sources: - - mysources/**/*.css - - exclude: mysources/ignoreme.css - generates: - - public/bundle.css -``` - -If you prefer these check to be made by the modification timestamp of the files, instead of its checksum (content), just set the `method` property to `timestamp`. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build . - sources: - - ./*.go - generates: - - app{{exeExt}} - method: timestamp -``` - -In situations where you need more flexibility the `status` keyword can be used. You can even combine the two. See the documentation for [status](#using-programmatic-checks-to-indicate-a-task-is-up-to-date) for an example. - -:::info - -By default, task stores checksums on a local `.task` directory in the project's directory. Most of the time, you'll want to have this directory on `.gitignore` (or equivalent) so it isn't committed. (If you have a task for code generation that is committed it may make sense to commit the checksum of that task as well, though). - -If you want these files to be stored in another directory, you can set a `TASK_TEMP_DIR` environment variable in your machine. It can contain a relative path like `tmp/task` that will be interpreted as relative to the project directory, or an absolute or home path like `/tmp/.task` or `~/.task` (subdirectories will be created for each project). - -```bash -export TASK_TEMP_DIR='~/.task' -``` - -::: - -:::info - -Each task has only one checksum stored for its `sources`. If you want to distinguish a task by any of its input variables, you can add those variables as part of the task's label, and it will be considered a different task. - -This is useful if you want to run a task once for each distinct set of inputs until the sources actually change. For example, if the sources depend on the value of a variable, or you if you want the task to rerun if some arguments change even if the source has not. - -::: - -:::tip - -The method `none` skips any validation and always run the task. - -::: - -:::info - -For the `checksum` (default) or `timestamp` method to work, it is only necessary to inform the source files. When the `timestamp` method is used, the last time of the running the task is considered as a generate. - -::: - -### Using programmatic checks to indicate a task is up to date - -Alternatively, you can inform a sequence of tests as `status`. If no error is returned (exit status 0), the task is considered up-to-date: - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - status: - - test -d directory - - test -f directory/file1.txt - - test -f directory/file2.txt -``` - -Normally, you would use `sources` in combination with `generates` - but for tasks that generate remote artifacts (Docker images, deploys, CD releases) the checksum source and timestamps require either access to the artifact or for an out-of-band refresh of the `.checksum` fingerprint file. - -Two special variables `{{.CHECKSUM}}` and `{{.TIMESTAMP}}` are available for interpolation within `status` commands, depending on the method assigned to fingerprint the sources. Only `source` globs are fingerprinted. - -Note that the `{{.TIMESTAMP}}` variable is a "live" Go `time.Time` struct, and can be formatted using any of the methods that `time.Time` responds to. - -See [the Go Time documentation](https://golang.org/pkg/time/) for more information. - -You can use `--force` or `-f` if you want to force a task to run even when up-to-date. - -Also, `task --status [tasks]...` will exit with a non-zero exit code if any of the tasks are not up-to-date. - -`status` can be combined with the [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) to have a task run if either the the source/generated artifacts changes, or the programmatic check fails: - -```yaml -version: '3' - -tasks: - build:prod: - desc: Build for production usage. - cmds: - - composer install - # Run this task if source files changes. - sources: - - composer.json - - composer.lock - generates: - - ./vendor/composer/installed.json - - ./vendor/autoload.php - # But also run the task if the last build was not a production build. - status: - - grep -q '"dev": false' ./vendor/composer/installed.json -``` - -### Using programmatic checks to cancel the execution of a task and its dependencies - -In addition to `status` checks, `preconditions` checks are the logical inverse of `status` checks. That is, if you need a certain set of conditions to be _true_ you can use the `preconditions` stanza. `preconditions` are similar to `status` lines, except they support `sh` expansion, and they SHOULD all return 0. - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - preconditions: - - test -f .env - - sh: '[ 1 = 0 ]' - msg: "One doesn't equal Zero, Halting" -``` - -Preconditions can set specific failure messages that can tell a user what steps to take using the `msg` field. - -If a task has a dependency on a sub-task with a precondition, and that precondition is not met - the calling task will fail. Note that a task executed with a failing precondition will not run unless `--force` is given. - -Unlike `status`, which will skip a task if it is up to date and continue executing tasks that depend on it, a `precondition` will fail a task, along with any other tasks that depend on it. - -```yaml -version: '3' - -tasks: - task-will-fail: - preconditions: - - sh: 'exit 1' - - task-will-also-fail: - deps: - - task-will-fail - - task-will-still-fail: - cmds: - - task: task-will-fail - - echo "I will not run" -``` - -### Limiting when tasks run - -If a task executed by multiple `cmds` or multiple `deps` you can control when it is executed using `run`. `run` can also be set at the root of the Taskfile to change the behavior of all the tasks unless explicitly overridden. - -Supported values for `run`: - -- `always` (default) always attempt to invoke the task regardless of the number of previous executions -- `once` only invoke this task once regardless of the number of references -- `when_changed` only invokes the task once for each unique set of variables passed into the task - -```yaml -version: '3' - -tasks: - default: - cmds: - - task: generate-file - vars: { CONTENT: '1' } - - task: generate-file - vars: { CONTENT: '2' } - - task: generate-file - vars: { CONTENT: '2' } - - generate-file: - run: when_changed - deps: - - install-deps - cmds: - - echo {{.CONTENT}} - - install-deps: - run: once - cmds: - - sleep 5 # long operation like installing packages -``` - -### Ensuring required variables are set - -If you want to check that certain variables are set before running a task then you can use `requires`. This is useful when might not be clear to users which variables are needed, or if you want clear message about what is required. Also some tasks could have dangerous side effects if run with un-set variables. - -Using `requires` you specify an array of strings in the `vars` sub-section under `requires`, these strings are variable names which are checked prior to running the task. If any variables are un-set the the task will error and not run. - -Environmental variables are also checked. - -Syntax: - -```yaml -requires: - vars: [] # Array of strings -``` - -:::note - -Variables set to empty zero length strings, will pass the `requires` check. - -::: - -Example of using `requires`: - -```yaml -version: '3' - -tasks: - docker-build: - cmds: - - 'docker build . -t {{.IMAGE_NAME}}:{{.IMAGE_TAG}}' - - # Make sure these variables are set before running - requires: - vars: [IMAGE_NAME, IMAGE_TAG] -``` - -## Variables - -When doing interpolation of variables, Task will look for the below. They are listed below in order of importance (i.e. most important first): - -- Variables declared in the task definition -- Variables given while calling a task from another (See [Calling another task](#calling-another-task) above) -- Variables of the [included Taskfile](#including-other-taskfiles) (when the task is included) -- Variables of the [inclusion of the Taskfile](#vars-of-included-taskfiles) (when the task is included) -- Global variables (those declared in the `vars:` option in the Taskfile) -- Environment variables - -Example of sending parameters with environment variables: - -```bash -$ TASK_VARIABLE=a-value task do-something -``` - -:::tip - -A special variable `.TASK` is always available containing the task name. - -::: - -Since some shells do not support the above syntax to set environment variables (Windows) tasks also accept a similar style when not at the beginning of the command. - -```bash -$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!" -``` - -Example of locally declared vars: - -```yaml -version: '3' - -tasks: - print-var: - cmds: - - echo "{{.VAR}}" - vars: - VAR: Hello! -``` - -Example of global vars in a `Taskfile.yml`: - -```yaml -version: '3' - -vars: - GREETING: Hello from Taskfile! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -### Dynamic variables - -The below syntax (`sh:` prop in a variable) is considered a dynamic variable. The value will be treated as a command and the output assigned. If there are one or more trailing newlines, the last newline will be trimmed. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go - vars: - GIT_COMMIT: - sh: git log -n 1 --format=%h -``` - -This works for all types of variables. - -## Looping over values - -As of v3.28.0, Task allows you to loop over certain values and execute a command for each. There are a number of ways to do this depending on the type of value you want to loop over. - -### Looping over a static list - -The simplest kind of loop is an explicit one. This is useful when you want to loop over a set of values that are known ahead of time. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: ['foo.txt', 'bar.txt'] - cmd: cat {{ .ITEM }} -``` - -### Looping over your task's sources - -You are also able to loop over the sources of your task: - -```yaml -version: '3' - -tasks: - default: - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{ .ITEM }} -``` - -This will also work if you use globbing syntax in your sources. For example, if you specify a source for `*.txt`, the loop will iterate over all files that match that glob. - -Source paths will always be returned as paths relative to the task directory. If you need to convert this to an absolute path, you can use the built-in `joinPath` function. There are some [special variables](/api/#special-variables) that you may find useful for this. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_DIR: /path/to/dir - dir: '{{.MY_DIR}}' - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{joinPath .MY_DIR .ITEM}} -``` - -### Looping over variables - -To loop over the contents of a variable, you simply need to specify the variable you want to loop over. By default, variables will be split on any whitespace characters. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -If you need to split on a different character, you can do this by specifying the `split` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt,bar.txt - cmds: - - for: { var: MY_VAR, split: ',' } - cmd: cat {{.ITEM}} -``` - -All of this also works with dynamic variables! - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: - sh: find -type f -name '*.txt' - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -### Renaming variables - -If you want to rename the iterator variable to make it clearer what the value contains, you can do so by specifying the `as` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR, as: FILE } - cmd: cat {{.FILE}} -``` - -### Looping over tasks - -Because the `for` property is defined at the `cmds` level, you can also use it alongside the `task` keyword to run tasks multiple times with different variables. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: my-task - vars: - FILE: '{{.ITEM}}' - - my-task: - cmds: - - echo '{{.FILE}}' -``` - -Or if you want to run different tasks depending on the value of the loop: - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: task-{{.ITEM}} - - task-foo: - cmds: - - echo 'foo' - - task-bar: - cmds: - - echo 'bar' -``` - -## Forwarding CLI arguments to commands - -If `--` is given in the CLI, all following parameters are added to a special `.CLI_ARGS` variable. This is useful to forward arguments to another command. - -The below example will run `yarn install`. - -```bash -$ task yarn -- install -``` - -```yaml -version: '3' - -tasks: - yarn: - cmds: - - yarn {{.CLI_ARGS}} -``` - -## Doing task cleanup with `defer` - -With the `defer` keyword, it's possible to schedule cleanup to be run once the task finishes. The difference with just putting it as the last command is that this command will run even when the task fails. - -In the example below, `rm -rf tmpdir/` will run even if the third command fails: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: rm -rf tmpdir/ - - echo 'Do work on tmpdir/' -``` - -If you want to move the cleanup command into another task, that is possible as well: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: { task: cleanup } - - echo 'Do work on tmpdir/' - - cleanup: rm -rf tmpdir/ -``` - -:::info - -Due to the nature of how the [Go's own `defer` work](https://go.dev/tour/flowcontrol/13), the deferred commands are executed in the reverse order if you schedule multiple of them. - -::: - -## Go's template engine - -Task parse commands as [Go's template engine][gotemplate] before executing them. Variables are accessible through dot syntax (`.VARNAME`). - -All functions by the Go's [slim-sprig lib](https://go-task.github.io/slim-sprig/) are available. The following example gets the current date in a given format: - -```yaml -version: '3' - -tasks: - print-date: - cmds: - - echo {{now | date "2006-01-02"}} -``` - -Task also adds the following functions: - -- `OS`: Returns the operating system. Possible values are `windows`, `linux`, `darwin` (macOS) and `freebsd`. -- `ARCH`: return the architecture Task was compiled to: `386`, `amd64`, `arm` or `s390x`. -- `splitLines`: Splits Unix (`\n`) and Windows (`\r\n`) styled newlines. -- `catLines`: Replaces Unix (`\n`) and Windows (`\r\n`) styled newlines with a space. -- `toSlash`: Does nothing on Unix, but on Windows converts a string from `\` path format to `/`. -- `fromSlash`: Opposite of `toSlash`. Does nothing on Unix, but on Windows converts a string from `/` path format to `\`. -- `exeExt`: Returns the right executable extension for the current OS (`".exe"` for Windows, `""` for others). -- `shellQuote`: Quotes a string to make it safe for use in shell scripts. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote) for this. The Bash dialect is assumed. -- `splitArgs`: Splits a string as if it were a command's arguments. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/shell#Fields) - -Example: - -```yaml -version: '3' - -tasks: - print-os: - cmds: - - echo '{{OS}} {{ARCH}}' - - echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}' - # This will be path/to/file on Unix but path\to\file on Windows - - echo '{{fromSlash "path/to/file"}}' - enumerated-file: - vars: - CONTENT: | - foo - bar - cmds: - - | - cat << EOF > output.txt - {{range $i, $line := .CONTENT | splitLines -}} - {{printf "%3d" $i}}: {{$line}} - {{end}}EOF -``` - -## Help - -Running `task --list` (or `task -l`) lists all tasks with a description. The following Taskfile: - -```yaml -version: '3' - -tasks: - build: - desc: Build the go binary. - cmds: - - go build -v -i main.go - - test: - desc: Run all the go tests. - cmds: - - go test -race ./... - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -would print the following output: - -```bash -* build: Build the go binary. -* test: Run all the go tests. -``` - -If you want to see all tasks, there's a `--list-all` (alias `-a`) flag as well. - -## Display summary of task - -Running `task --summary task-name` will show a summary of a task. The following Taskfile: - -```yaml -version: '3' - -tasks: - release: - deps: [build] - summary: | - Release your project to github - - It will build your project before starting the release. - Please make sure that you have set GITHUB_TOKEN before starting. - cmds: - - your-release-tool - - build: - cmds: - - your-build-tool -``` - -with running `task --summary release` would print the following output: - -``` -task: release - -Release your project to github - -It will build your project before starting the release. -Please make sure that you have set GITHUB_TOKEN before starting. - -dependencies: - - build - -commands: - - your-release-tool -``` - -If a summary is missing, the description will be printed. If the task does not have a summary or a description, a warning is printed. - -Please note: _showing the summary will not execute the command_. - -## Псевдонимы task - -Aliases are alternative names for tasks. They can be used to make it easier and quicker to run tasks with long or hard-to-type names. You can use them on the command line, when [calling sub-tasks](#calling-another-task) in your Taskfile and when [including tasks](#including-other-taskfiles) with aliases from another Taskfile. They can also be used together with [namespace aliases](#namespace-aliases). - -```yaml -version: '3' - -tasks: - generate: - aliases: [gen] - cmds: - - task: gen-mocks - - generate-mocks: - aliases: [gen-mocks] - cmds: - - echo "generating..." -``` - -## Overriding task name - -Sometimes you may want to override the task name printed on the summary, up-to-date messages to STDOUT, etc. In this case, you can just set `label:`, which can also be interpolated with variables: - -```yaml -version: '3' - -tasks: - default: - - task: print - vars: - MESSAGE: hello - - task: print - vars: - MESSAGE: world - - print: - label: 'print-{{.MESSAGE}}' - cmds: - - echo "{{.MESSAGE}}" -``` - -## Warning Prompts - -Warning Prompts are used to prompt a user for confirmation before a task is executed. - -Below is an example using `prompt` with a dangerous command, that is called between two safe commands: - -```yaml -version: '3' - -tasks: - example: - cmds: - - task: not-dangerous - - task: dangerous - - task: another-not-dangerous - - not-dangerous: - cmds: - - echo 'not dangerous command' - - another-not-dangerous: - cmds: - - echo 'another not dangerous command' - - dangerous: - prompt: This is a dangerous command... Do you want to continue? - cmds: - - echo 'dangerous command' -``` - -```bash -❯ task dangerous -task: "This is a dangerous command... Do you want to continue?" [y/N] -``` - -Warning prompts are called before executing a task. If a prompt is denied Task will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue as normal. - -```bash -❯ task example -not dangerous command -task: "This is a dangerous command. Do you want to continue?" [y/N] -y -dangerous command -another not dangerous command -``` - -To skip warning prompts automatically, you can use the `--yes` (alias `-y`) option when calling the task. By including this option, all warnings, will be automatically confirmed, and no prompts will be shown. - -:::caution - -Tasks with prompts always fail by default on non-terminal environments, like a CI, where an `stdin` won't be available for the user to answer. In those cases, use `--yes` (`-y`) to force all tasks with a prompt to run. - -::: - -## Silent mode - -Silent mode disables the echoing of commands before Task runs it. For the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" -``` - -Normally this will be printed: - -```sh -echo "Print something" -Print something -``` - -With silent mode on, the below will be printed instead: - -```sh -Print something -``` - -There are four ways to enable silent mode: - -- At command level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: echo "Print something" - silent: true -``` - -- At task level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" - silent: true -``` - -- Globally at Taskfile level: - -```yaml -version: '3' - -silent: true - -tasks: - echo: - cmds: - - echo "Print something" -``` - -- Or globally with `--silent` or `-s` flag - -If you want to suppress STDOUT instead, just redirect a command to `/dev/null`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "This will print nothing" > /dev/null -``` - -## Dry run mode - -Dry run mode (`--dry`) compiles and steps through each task, printing the commands that would be run without executing them. This is useful for debugging your Taskfiles. - -## Ignore errors - -You have the option to ignore errors during command execution. Given the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - exit 1 - - echo "Hello World" -``` - -Task will abort the execution after running `exit 1` because the status code `1` stands for `EXIT_FAILURE`. However, it is possible to continue with execution using `ignore_error`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "Hello World" -``` - -`ignore_error` can also be set for a task, which means errors will be suppressed for all commands. Nevertheless, keep in mind that this option will not propagate to other tasks called either by `deps` or `cmds`! - -## Output syntax - -By default, Task just redirects the STDOUT and STDERR of the running commands to the shell in real-time. This is good for having live feedback for logging printed by commands, but the output can become messy if you have multiple commands running simultaneously and printing lots of stuff. - -To make this more customizable, there are currently three different output options you can choose: - -- `interleaved` (default) -- `group` -- `prefixed` - -To choose another one, just set it to root in the Taskfile: - -```yaml -version: '3' - -output: 'group' - -tasks: - # ... -``` - -The `group` output will print the entire output of a command once after it finishes, so you will not have live feedback for commands that take a long time to run. - -When using the `group` output, you can optionally provide a templated message to print at the start and end of the group. This can be useful for instructing CI systems to group all of the output for a given task, such as with [GitHub Actions' `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) or [Azure Pipelines](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?expand=1&view=azure-devops&tabs=bash#formatting-commands). - -```yaml -version: '3' - -output: - group: - begin: '::group::{{.TASK}}' - end: '::endgroup::' - -tasks: - default: - cmds: - - echo 'Hello, World!' - silent: true -``` - -```bash -$ task default -::group::default -Hello, World! -::endgroup:: -``` - -When using the `group` output, you may swallow the output of the executed command on standard output and standard error if it does not fail (zero exit code). - -```yaml -version: '3' - -silent: true - -output: - group: - error_only: true - -tasks: - passes: echo 'output-of-passes' - errors: echo 'output-of-errors' && exit 1 -``` - -```bash -$ task passes -$ task errors -output-of-errors -task: Failed to run task "errors": exit status 1 -``` - -The `prefix` output will prefix every line printed by a command with `[task-name]` as the prefix, but you can customize the prefix for a command with the `prefix:` attribute: - -```yaml -version: '3' - -output: prefixed - -tasks: - default: - deps: - - task: print - vars: { TEXT: foo } - - task: print - vars: { TEXT: bar } - - task: print - vars: { TEXT: baz } - - print: - cmds: - - echo "{{.TEXT}}" - prefix: 'print-{{.TEXT}}' - silent: true -``` - -```bash -$ task default -[print-foo] foo -[print-bar] bar -[print-baz] baz -``` - -:::tip - -The `output` option can also be specified by the `--output` or `-o` flags. - -::: - -## Interactive CLI application - -When running interactive CLI applications inside Task they can sometimes behave weirdly, especially when the [output mode](#output-syntax) is set to something other than `interleaved` (the default), or when interactive apps are run in parallel with other tasks. - -The `interactive: true` tells Task this is an interactive application and Task will try to optimize for it: - -```yaml -version: '3' - -tasks: - default: - cmds: - - vim my-file.txt - interactive: true -``` - -If you still have problems running an interactive app through Task, please open an issue about it. - -## Short task syntax - -Starting on Task v3, you can now write tasks with a shorter syntax if they have the default settings (e.g. no custom `env:`, `vars:`, `desc:`, `silent:` , etc): - -```yaml -version: '3' - -tasks: - build: go build -v -o ./app{{exeExt}} . - - run: - - task: build - - ./app{{exeExt}} -h localhost -p 8080 -``` - -## `set` and `shopt` - -It's possible to specify options to the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins. This can be added at global, task or command level. - -```yaml -version: '3' - -set: [pipefail] -shopt: [globstar] - -tasks: - # `globstar` required for double star globs to work - default: echo **/*.go -``` - -:::info - -Keep in mind that not all options are available in the [shell interpreter library](https://github.com/mvdan/sh) that Task uses. - -::: - -## Watch tasks - -With the flags `--watch` or `-w` task will watch for file changes and run the task again. This requires the `sources` attribute to be given, so task knows which files to watch. - -The default watch interval is 5 seconds, but it's possible to change it by either setting `interval: '500ms'` in the root of the Taskfile passing it as an argument like `--interval=500ms`. - -Also, it's possible to set `watch: true` in a given task and it'll automatically run in watch mode: - -```yaml -version: '3' - -interval: 500ms - -tasks: - build: - desc: Builds the Go application - watch: true - sources: - - '**/*.go' - cmds: - - go build # ... -``` - -:::info - -Note that when setting `watch: true` to a task, it'll only run in watch mode when running from the CLI via `task my-watch-task`, but won't run in watch mode if called by another task, either directly or as a dependency. - -::: - - - - -[gotemplate]: https://golang.org/pkg/text/template/ diff --git a/docs/i18n/ru-RU/docusaurus-theme-classic/footer.json b/docs/i18n/ru-RU/docusaurus-theme-classic/footer.json deleted file mode 100644 index 111065ba..00000000 --- a/docs/i18n/ru-RU/docusaurus-theme-classic/footer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "link.title.Pages": { - "message": "Pages", - "description": "The title of the footer links column with title=Pages in the footer" - }, - "link.title.Community": { - "message": "Community", - "description": "The title of the footer links column with title=Community in the footer" - }, - "link.title.Translations": { - "message": "Translations", - "description": "The title of the footer links column with title=Translations in the footer" - }, - "link.item.label.Installation": { - "message": "Installation", - "description": "The label of footer link with label=Installation linking to /installation/" - }, - "link.item.label.Usage": { - "message": "Usage", - "description": "The label of footer link with label=Usage linking to /usage/" - }, - "link.item.label.Donate": { - "message": "Donate", - "description": "The label of footer link with label=Donate linking to /donate/" - }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/go-task/task" - }, - "link.item.label.Twitter": { - "message": "Twitter", - "description": "The label of footer link with label=Twitter linking to https://twitter.com/taskfiledev" - }, - "link.item.label.Mastodon": { - "message": "Mastodon", - "description": "The label of footer link with label=Mastodon linking to https://fosstodon.org/@task" - }, - "link.item.label.Discord": { - "message": "Discord", - "description": "The label of footer link with label=Discord linking to https://discord.gg/6TY36E39UK" - }, - "link.item.label.OpenCollective": { - "message": "OpenCollective", - "description": "The label of footer link with label=OpenCollective linking to https://opencollective.com/task" - } -} diff --git a/docs/i18n/ru-RU/docusaurus-theme-classic/navbar.json b/docs/i18n/ru-RU/docusaurus-theme-classic/navbar.json deleted file mode 100644 index 4bab333c..00000000 --- a/docs/i18n/ru-RU/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "title": { - "message": "Task", - "description": "The title in the navbar" - }, - "item.label.Installation": { - "message": "Installation", - "description": "Navbar item with label Installation" - }, - "item.label.Usage": { - "message": "Usage", - "description": "Navbar item with label Usage" - }, - "item.label.API": { - "message": "API", - "description": "Navbar item with label API" - }, - "item.label.Donate": { - "message": "Donate", - "description": "Navbar item with label Donate" - }, - "item.label.GitHub": { - "message": "GitHub", - "description": "Navbar item with label GitHub" - }, - "item.label.Twitter": { - "message": "Twitter", - "description": "Navbar item with label Twitter" - }, - "item.label.Mastodon": { - "message": "Mastodon", - "description": "Navbar item with label Mastodon" - }, - "item.label.Discord": { - "message": "Discord", - "description": "Navbar item with label Discord" - } -} diff --git a/docs/i18n/tr-TR/code.json b/docs/i18n/tr-TR/code.json deleted file mode 100644 index c1b2ff90..00000000 --- a/docs/i18n/tr-TR/code.json +++ /dev/null @@ -1,396 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "Bu sayfa çöktü.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Tekrar deneyin", - "description": "The label of the button to try again when the page crashed" - }, - "theme.NotFound.title": { - "message": "Sayfa Bulunamadı", - "description": "The title of the 404 page" - }, - "theme.NotFound.p1": { - "message": "Aradığınız şeyi bulamadık.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Lütfen sizi orijinal URL'ye yönlendiren sitenin sahibiyle iletişime geçin ve bağlantısının bozuk olduğunu bildirin.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.admonition.note": { - "message": "not", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "ipucu", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.danger": { - "message": "tehlike", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "bilgi", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.caution": { - "message": "uyarı", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Başa dön", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "Arşiv", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Arşive", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Blog listesi sayfasında gezinme", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Daha Yeni Girdiler", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Daha Eski Girdiler", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Blog gönderi sayfasında gezinme", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Daha Yeni Gönderi", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Daha Eski Gönderi", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "Bir gönderi|{count} gönderi", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "\"{tagName}\" ile etiketlenmiş {nPosts}", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "Tüm Etiketleri Görüntüle", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Koyu ve açık mod arasında geçiş yap (geçerli mod {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "koyu mod", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "açık mod", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.home": { - "message": "Ana sayfa", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Breadcrumbs", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} öğe", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Dokümanlar sayfalarında gezinme", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Önceki", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Sonraki", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "Bir belge etiketlendi|{count} belge etiketlendi", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} with \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Sürüm: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "This is unreleased documentation for {siteTitle} {versionLabel} version.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "en son sürüm", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Bu sayfayı düzenle", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Başlığa doğrudan bağlantı", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " {date} tarihinde", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " {user} tarafından", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Son güncelleme{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Sürümler", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Etiketler:", - "description": "The label alongside a tag list" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Kapat", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "En son blog gönderilerinde gezinme", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Kopyalandı", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Kodu panoya kopyala", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "Kopyala", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Sözcük kaydırmayı aç/kapat", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "'{label}' daralabilen kenar çubuğu kategorisini aç/kapa", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Diller", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "Bu Sayfada", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "Devamını Oku", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "{title} hakkında daha fazla oku", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "Bir dakika okuma süresi|{readingTime} dakika okuma süresi", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Kenar çubuğunu daralt", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Kenar çubuğunu daralt", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Gezinme çubuğunu kapat", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "←Ana menüye dön", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Gezinme çubuğunu aç/kapat", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Kenar çubuğunu genişlet", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Kenar çubuğunu genişlet", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.seeAll": { - "message": "{count} sonucun hepsini gör" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "Bir belge bulundu|{count} belge bulundu", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "\"{query}\" için arama sonuçları", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Belgelerde ara", - "description": "The search page title for empty query" - }, - "theme.SearchPage.inputPlaceholder": { - "message": "Aramak istediğiniz şeyi buraya yazın", - "description": "The placeholder for search page input" - }, - "theme.SearchPage.inputLabel": { - "message": "Ara", - "description": "The ARIA label for search page input" - }, - "theme.SearchPage.algoliaLabel": { - "message": "Algolia ile Ara", - "description": "The ARIA label for Algolia mention" - }, - "theme.SearchPage.noResultsText": { - "message": "Sonuç bulunamadı", - "description": "The paragraph for empty search result" - }, - "theme.SearchPage.fetchingNewResults": { - "message": "Yeni sonuçlar yükleniyor...", - "description": "The paragraph for fetching new search results" - }, - "theme.SearchBar.label": { - "message": "Ara", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchModal.searchBox.resetButtonTitle": { - "message": "Aramayı temizle", - "description": "The label and ARIA label for search box reset button" - }, - "theme.SearchModal.searchBox.cancelButtonText": { - "message": "İptal", - "description": "The label and ARIA label for search box cancel button" - }, - "theme.SearchModal.startScreen.recentSearchesTitle": { - "message": "En Son", - "description": "The title for recent searches" - }, - "theme.SearchModal.startScreen.noRecentSearchesText": { - "message": "Son arama yok", - "description": "The text when no recent searches" - }, - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { - "message": "Bu aramayı kaydet", - "description": "The label for save recent search button" - }, - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { - "message": "Bu aramayı geçmişten kaldır", - "description": "The label for remove recent search button" - }, - "theme.SearchModal.startScreen.favoriteSearchesTitle": { - "message": "Favori", - "description": "The title for favorite searches" - }, - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { - "message": "Bu aramayı favorilerden kaldır", - "description": "The label for remove favorite search button" - }, - "theme.SearchModal.errorScreen.titleText": { - "message": "Sonuçlar yüklenemedi", - "description": "The title for error screen of search modal" - }, - "theme.SearchModal.errorScreen.helpText": { - "message": "Ağ bağlantınızı gözden geçirmek isteyebilirsiniz.", - "description": "The help text for error screen of search modal" - }, - "theme.SearchModal.footer.selectText": { - "message": "seç", - "description": "The explanatory text of the action for the enter key" - }, - "theme.SearchModal.footer.selectKeyAriaLabel": { - "message": "Anahtarı girin", - "description": "The ARIA label for the Enter key button that makes the selection" - }, - "theme.SearchModal.footer.navigateText": { - "message": "gezin", - "description": "The explanatory text of the action for the Arrow up and Arrow down key" - }, - "theme.SearchModal.footer.navigateUpKeyAriaLabel": { - "message": "Yukarı ok", - "description": "The ARIA label for the Arrow up key button that makes the navigation" - }, - "theme.SearchModal.footer.navigateDownKeyAriaLabel": { - "message": "Aşağı ok", - "description": "The ARIA label for the Arrow down key button that makes the navigation" - }, - "theme.SearchModal.footer.closeText": { - "message": "kapatın", - "description": "The explanatory text of the action for Escape key" - }, - "theme.SearchModal.footer.closeKeyAriaLabel": { - "message": "Escape tuşu", - "description": "The ARIA label for the Escape key button that close the modal" - }, - "theme.SearchModal.footer.searchByText": { - "message": "Arama", - "description": "The text explain that the search is making by Algolia" - }, - "theme.SearchModal.noResultsScreen.noResultsText": { - "message": "Sonuç bulunamadı", - "description": "The text explains that there are no results for the following search" - }, - "theme.SearchModal.noResultsScreen.suggestedQueryText": { - "message": "Şunu aramayı deneyin", - "description": "The text for the suggested query when no results are found for the following search" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsText": { - "message": "Bu aramanın sonuç vereceğine inanıyor musunuz?", - "description": "The text for the question where the user thinks there are missing results" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { - "message": "Bize bildirin.", - "description": "The text for the link to report missing results" - }, - "theme.SearchModal.placeholder": { - "message": "Belgelerde ara", - "description": "The placeholder of the input of the DocSearch pop-up modal" - }, - "theme.common.skipToMainContent": { - "message": "Ana içeriğe atla", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Etiketler", - "description": "The title of the tag list page" - } -} diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md b/docs/i18n/tr-TR/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md deleted file mode 100644 index 42d99117..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Introducing Experiments -description: A look at where task is, where it's going and how we're going to get there. -slug: task-in-2023 -authors: - - pd93 -tags: - - experiments - - breaking-changes - - roadmap - - v4 -image: https://i.imgur.com/mErPwqL.png -hide_table_of_contents: false ---- - -Lately, Task has been growing extremely quickly and I've found myself thinking a lot about the future of the project and how we continue to evolve and grow. I'm not much of a writer, but I think one of the things we could do better is to communicate these kinds of thoughts to the community. So, with that in mind, this is the first (hopefully of many) blog posts talking about Task and what we're up to. - - - -## :calendar: So, what have we been up to? - -Over the past 12 months or so, [@andreynering][] (Author and maintainer of the project) and I ([@pd93][]) have been working in our spare time to maintain and improve v3 of Task and we've made some amazing progress. Here are just some of the things we've released in that time: - -- An official [extension for VS Code][vscode-task]. -- Internal Tasks ([#818](https://github.com/go-task/task/pull/818)). -- Task aliases ([#879](https://github.com/go-task/task/pull/879)). -- Looping over tasks ([#1220](https://github.com/go-task/task/pull/1200)). -- A series of refactors to the core codebase to make it more maintainable and extensible. -- Loads of bug fixes and improvements. -- An integration with [Crowdin][crowdin]. Work is in progress on making our docs available in **7 new languages** (Special thanks to all our translators for the huge help with this!). -- And much, much more! :sparkles: - -We're also working on adding some really exciting and highly requested features to Task such as having the ability to run remote Taskfiles ([#1317](https://github.com/go-task/task/issues/1317)). - -None of this would have been possible without the [150 or so (and growing) contributors][contributors] to the project, numerous sponsors and a passionate community of users. Together we have more than doubled the number of GitHub stars to over 8400 :star: since the beginning of 2022 and this continues to accelerate. We can't thank you all enough for your help and support! :rocket: - -[![Star History Chart](https://api.star-history.com/svg?repos=go-task/task&type=Date)](https://star-history.com/#go-task/task&Date) - -## What's next? :thinking: - -It's extremely motivating to see so many people using and loving Task. However, in this time we've also seen an increase in the number of issues and feature requests. In particular, issues that require some kind of breaking change to Task. This isn't a bad thing, but as we grow we need to be more responsible about how we address these changes in a way that ensures stability and compatibility for existing users and their Taskfiles. - -At this point you're probably thinking something like: - -> "But you use [semantic versioning][semver] - Just release a new major version with your breaking changes." - -And you'd be right... sort of. In theory, this sounds great, but the reality is that we don't have the time to commit to a major overhaul of Task in one big bang release. This would require a colossal amount of time and coordination and with full time jobs and personal lives to tend to, this is a difficult commitment to make. Smaller, more frequent major releases are also a significant inconvenience for users as they have to constantly keep up-to-date with our breaking changes. Fortunately, there is a better way. - -## What's going to change? :monocle: - -Going forwards, breaking changes will be allowed into _minor_ versions of Task as "experimental features". To access these features users will need opt-in by enabling feature flags. This will allow us to release new features slowly and gather feedback from the community before making them the default behavior in a future major release. - -To prepare users for the next major release, we will maintain a list of [deprecated features][deprecations] and [experiments][experiments] on our docs website and publish information on how to migrate to the new behavior. - -You can read the [full breaking change proposal][breaking-change-proposal] and view all the [current experiments and their status][experiments-project] on GitHub including the [Gentle Force][gentle-force-experiment] and [Remote Taskfiles][remote-taskfiles-experiment] experiments. - -## What will happen to v2/v3 features? - -v2 has been [officially deprecated][deprecate-version-2-schema]. If you're still using a Taskfile with `version: "2"` at the top we _strongly recommend_ that you upgrade as soon as possible. Removing v2 will allow us to tidy up the codebase and focus on new functionality instead. - -When v4 is released, we will continue to support v3 for a period of time (bug fixes etc). However, since we are moving from a backward-compatibility model to a forwards-compatibility model, **v4 itself will not be backwards compatible with v3**. - -## v4 When? :eyes: - -:man_shrugging: When it's ready. - -In all seriousness, we don't have a timeline for this yet. We'll be working on the most serious deficiencies of the v3 API first and regularly evaluating the state of the project. When we feel its in a good, stable place and we have a clear upgrade path for users and a number of stable experiments, we'll start to think about v4. - -## :wave: Final thoughts - -Task is growing fast and we're excited to see where it goes next. We hope that the steps we're taking to improve the project and our process will help us to continue to grow. As always, if you have any questions or feedback, we encourage you to comment on or open [issues][issues] and [discussions][discussions] on GitHub. Alternatively, you can join us on [Discord][discord]. - -I plan to write more of these blog posts in the future on a variety of Task-related topics, so make sure to check in occasionally and see what we're up to! - - - - -[vscode-task]: https://github.com/go-task/vscode-task -[crowdin]: https://crowdin.com -[contributors]: https://github.com/go-task/task/graphs/contributors -[semver]: https://semver.org -[breaking-change-proposal]: https://github.com/go-task/task/discussions/1191 -[@andreynering]: https://github.com/andreynering -[@pd93]: https://github.com/pd93 -[experiments]: https://taskfile.dev/experiments -[deprecations]: https://taskfile.dev/deprecations -[deprecate-version-2-schema]: https://github.com/go-task/task/issues/1197 -[issues]: https://github.com/go-task/task/issues -[discussions]: https://github.com/go-task/task/discussions -[discord]: https://discord.gg/6TY36E39UK -[experiments-project]: https://github.com/orgs/go-task/projects/1 -[gentle-force-experiment]: https://github.com/go-task/task/issues/1200 -[remote-taskfiles-experiment]: https://github.com/go-task/task/issues/1317 diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-blog/authors.yml b/docs/i18n/tr-TR/docusaurus-plugin-content-blog/authors.yml deleted file mode 100644 index cc93fa30..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-blog/authors.yml +++ /dev/null @@ -1,10 +0,0 @@ -andreynering: - name: Andrey Nering - title: Task'ın Geliştiricisi - url: https://github.com/andreynering - image_url: https://github.com/andreynering.png -pd93: - name: Pete Davison - title: Maintainer of Task - url: https://github.com/pd93 - image_url: https://github.com/pd93.png diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current.json b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index 33824630..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version.label": { - "message": "Sonraki", - "description": "The label for version current" - } -} diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/api_reference.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/api_reference.md deleted file mode 100644 index ef34badb..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/api_reference.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -slug: /api/ -sidebar_position: 4 -toc_min_heading_level: 2 -toc_max_heading_level: 5 ---- - -# API Reference - -## CLI - -Task command line tool has the following syntax: - -```bash -task [--flags] [tasks...] [-- CLI_ARGS...] -``` - -:::tip - -If `--` is given, all remaining arguments will be assigned to a special `CLI_ARGS` variable - -::: - -| Short | Flag | Type | Default | Description | -| ----- | --------------------------- | -------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-c` | `--color` | `bool` | `true` | Colored output. Enabled by default. Set flag to `false` or use `NO_COLOR=1` to disable. | -| `-C` | `--concurrency` | `int` | `0` | Limit number tasks to run concurrently. Zero means unlimited. | -| `-d` | `--dir` | `string` | Working directory | Sets directory of execution. | -| `-n` | `--dry` | `bool` | `false` | Compiles and prints tasks in the order that they would be run, without executing them. | -| `-x` | `--exit-code` | `bool` | `false` | Pass-through the exit code of the task command. | -| `-f` | `--force` | `bool` | `false` | Forces execution even when the task is up-to-date. | -| `-g` | `--global` | `bool` | `false` | Runs global Taskfile, from `$HOME/Taskfile.{yml,yaml}`. | -| `-h` | `--help` | `bool` | `false` | Shows Task usage. | -| `-i` | `--init` | `bool` | `false` | Creates a new Taskfile.yml in the current folder. | -| `-I` | `--interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `-l` | `--list` | `bool` | `false` | Lists tasks with description of current Taskfile. | -| `-a` | `--list-all` | `bool` | `false` | Lists tasks with or without a description. | -| | `--sort` | `string` | `default` | Changes the order of the tasks when listed.
`default` - Alphanumeric with root tasks first
`alphanumeric` - Alphanumeric
`none` - No sorting (As they appear in the Taskfile) | -| | `--json` | `bool` | `false` | See [JSON Output](#json-output) | -| `-o` | `--output` | `string` | Default set in the Taskfile or `intervealed` | Sets output style: [`interleaved`/`group`/`prefixed`]. | -| | `--output-group-begin` | `string` | | Message template to print before a task's grouped output. | -| | `--output-group-end` | `string` | | Message template to print after a task's grouped output. | -| | `--output-group-error-only` | `bool` | `false` | Swallow command output on zero exit code. | -| `-p` | `--parallel` | `bool` | `false` | Executes tasks provided on command line in parallel. | -| `-s` | `--silent` | `bool` | `false` | Disables echoing. | -| `-y` | `--yes` | `bool` | `false` | Assume "yes" as answer to all prompts. | -| | `--status` | `bool` | `false` | Exits with non-zero exit code if any of the given tasks is not up-to-date. | -| | `--summary` | `bool` | `false` | Show summary about a task. | -| `-t` | `--taskfile` | `string` | `Taskfile.yml` or `Taskfile.yaml` | | -| `-v` | `--verbose` | `bool` | `false` | Enables verbose mode. | -| | `--version` | `bool` | `false` | Show Task version. | -| `-w` | `--watch` | `bool` | `false` | Enables watch of the given task. | - -## Exit Codes - -Task will sometimes exit with specific exit codes. These codes are split into three groups with the following ranges: - -- General errors (0-99) -- Taskfile errors (100-199) -- Task errors (200-299) - -A full list of the exit codes and their descriptions can be found below: - -| Code | Description | -| ---- | ------------------------------------------------------------ | -| 0 | Success | -| 1 | An unknown error occurred | -| 100 | No Taskfile was found | -| 101 | A Taskfile already exists when trying to initialize one | -| 102 | The Taskfile is invalid or cannot be parsed | -| 103 | A remote Taskfile could not be downloaded | -| 104 | A remote Taskfile was not trusted by the user | -| 105 | A remote Taskfile was could not be fetched securely | -| 106 | No cache was found for a remote Taskfile in offline mode | -| 107 | No schema version was defined in the Taskfile | -| 200 | The specified task could not be found | -| 201 | An error occurred while executing a command inside of a task | -| 202 | The user tried to invoke a task that is internal | -| 203 | There a multiple tasks with the same name or alias | -| 204 | A task was called too many times | -| 205 | A task was cancelled by the user | -| 206 | A task was not executed due to missing required variables | - -These codes can also be found in the repository in [`errors/errors.go`](https://github.com/go-task/task/blob/main/errors/errors.go). - -:::info - -When Task is run with the `-x`/`--exit-code` flag, the exit code of any failed commands will be passed through to the user instead. - -::: - -## JSON Output - -When using the `--json` flag in combination with either the `--list` or `--list-all` flags, the output will be a JSON object with the following structure: - -```json -{ - "tasks": [ - { - "name": "", - "desc": "", - "summary": "", - "up_to_date": false, - "location": { - "line": 54, - "column": 3, - "taskfile": "/path/to/Taskfile.yml" - } - } - // ... - ], - "location": "/path/to/Taskfile.yml" -} -``` - -## Special Variables - -There are some special variables that is available on the templating system: - -| Var | Description | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CLI_ARGS` | Contain all extra arguments passed after `--` when calling Task through the CLI. | -| `CLI_FORCE` | A boolean containing whether the `--force` or `--force-all` flags were set. | -| `TASK` | The name of the current task. | -| `ROOT_DIR` | The absolute path of the root Taskfile. | -| `TASKFILE_DIR` | The absolute path of the included Taskfile. | -| `USER_WORKING_DIR` | The absolute path of the directory `task` was called from. | -| `CHECKSUM` | The checksum of the files listed in `sources`. Only available within the `status` prop and if method is set to `checksum`. | -| `TIMESTAMP` | The date object of the greatest timestamp of the files listed in `sources`. Only available within the `status` prop and if method is set to `timestamp`. | -| `TASK_VERSION` | The current version of task. | -| `ITEM` | The value of the current iteration when using the `for` property. Can be changed to a different variable name using `as:`. | - -## ENV - -Some environment variables can be overridden to adjust Task behavior. - -| ENV | Default | Description | -| -------------------- | ------- | ----------------------------------------------------------------------------------------------------------------- | -| `TASK_TEMP_DIR` | `.task` | Location of the temp dir. Can relative to the project like `tmp/task` or absolute like `/tmp/.task` or `~/.task`. | -| `TASK_COLOR_RESET` | `0` | Color used for white. | -| `TASK_COLOR_BLUE` | `34` | Color used for blue. | -| `TASK_COLOR_GREEN` | `32` | Color used for green. | -| `TASK_COLOR_CYAN` | `36` | Color used for cyan. | -| `TASK_COLOR_YELLOW` | `33` | Color used for yellow. | -| `TASK_COLOR_MAGENTA` | `35` | Color used for magenta. | -| `TASK_COLOR_RED` | `31` | Color used for red. | -| `FORCE_COLOR` | | Force color output usage. | - -## Taskfile Schema - -| Attribute | Type | Default | Description | -| ---------- | ---------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `version` | `string` | | Version of the Taskfile. The current version is `3`. | -| `output` | `string` | `interleaved` | Output mode. Available options: `interleaved`, `group` and `prefixed`. | -| `method` | `string` | `checksum` | Default method in this Taskfile. Can be overridden in a task by task basis. Available options: `checksum`, `timestamp` and `none`. | -| `includes` | [`map[string]Include`](#include) | | Additional Taskfiles to be included. | -| `vars` | [`map[string]Variable`](#variable) | | A set of global variables. | -| `env` | [`map[string]Variable`](#variable) | | A set of global environment variables. | -| `tasks` | [`map[string]Task`](#task) | | A set of task definitions. | -| `silent` | `bool` | `false` | Default 'silent' options for this Taskfile. If `false`, can be overridden with `true` in a task by task basis. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `run` | `string` | `always` | Default 'run' option for this Taskfile. Available options: `always`, `once` and `when_changed`. | -| `interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -### Include - -| Attribute | Type | Default | Description | -| ---------- | --------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `taskfile` | `string` | | The path for the Taskfile or directory to be included. If a directory, Task will look for files named `Taskfile.yml` or `Taskfile.yaml` inside that directory. If a relative path, resolved relative to the directory containing the including Taskfile. | -| `dir` | `string` | The parent Taskfile directory | The working directory of the included tasks when run. | -| `optional` | `bool` | `false` | If `true`, no errors will be thrown if the specified file does not exist. | -| `internal` | `bool` | `false` | Stops any task in the included Taskfile from being callable on the command line. These commands will also be omitted from the output when used with `--list`. | -| `aliases` | `[]string` | | Alternative names for the namespace of the included Taskfile. | -| `vars` | `map[string]Variable` | | A set of variables to apply to the included Taskfile. | - -:::info - -Informing only a string like below is equivalent to setting that value to the `taskfile` attribute. - -```yaml -includes: - foo: ./path -``` - -::: - -### Variable - -| Attribute | Type | Default | Description | -| --------- | -------- | ------- | ------------------------------------------------------------------------ | -| _itself_ | `string` | | A static value that will be set to the variable. | -| `sh` | `string` | | A shell command. The output (`STDOUT`) will be assigned to the variable. | - -:::info - -Static and dynamic variables have different syntaxes, like below: - -```yaml -vars: - STATIC: static - DYNAMIC: - sh: echo "dynamic" -``` - -::: - -### Task - -| Attribute | Type | Default | Description | -| --------------- | ---------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmds` | [`[]Command`](#command) | | A list of shell commands to be executed. | -| `deps` | [`[]Dependency`](#dependency) | | A list of dependencies of this task. Tasks defined here will run in parallel before this task. | -| `label` | `string` | | Overrides the name of the task in the output when a task is run. Supports variables. | -| `desc` | `string` | | A short description of the task. This is displayed when calling `task --list`. | -| `prompt` | `string` | | A prompt that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks. | -| `summary` | `string` | | A longer description of the task. This is displayed when calling `task --summary [task]`. | -| `aliases` | `[]string` | | A list of alternative names by which the task can be called. | -| `sources` | `[]string` | | A list of sources to check before running this task. Relevant for `checksum` and `timestamp` methods. Can be file paths or star globs. | -| `generates` | `[]string` | | A list of files meant to be generated by this task. Relevant for `timestamp` method. Can be file paths or star globs. | -| `status` | `[]string` | | A list of commands to check if this task should run. The task is skipped otherwise. This overrides `method`, `sources` and `generates`. | -| `requires` | `[]string` | | A list of variables which should be set if this task is to run, if any of these variables are unset the task will error and not run. | -| `preconditions` | [`[]Precondition`](#precondition) | | A list of commands to check if this task should run. If a condition is not met, the task will error. | -| `requires` | [`Requires`](#requires) | | A list of required variables which should be set if this task is to run, if any variables listed are unset the task will error and not run. | -| `dir` | `string` | | The directory in which this task should run. Defaults to the current working directory. | -| `vars` | [`map[string]Variable`](#variable) | | A set of variables that can be used in the task. | -| `env` | [`map[string]Variable`](#variable) | | A set of environment variables that will be made available to shell commands. | -| `dotenv` | `[]string` | | A list of `.env` file paths to be parsed. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. When combined with the `--list` flag, task descriptions will be hidden. | -| `interactive` | `bool` | `false` | Tells task that the command is interactive. | -| `internal` | `bool` | `false` | Stops a task from being callable on the command line. It will also be omitted from the output when used with `--list`. | -| `method` | `string` | `checksum` | Defines which method is used to check the task is up-to-date. `timestamp` will compare the timestamp of the sources and generates files. `checksum` will check the checksum (You probably want to ignore the .task folder in your .gitignore file). `none` skips any validation and always run the task. | -| `prefix` | `string` | | Defines a string to prefix the output of tasks running in parallel. Only used when the output mode is `prefixed`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing commands. | -| `run` | `string` | The one declared globally in the Taskfile or `always` | Specifies whether the task should run again or not if called more than once. Available options: `always`, `once` and `when_changed`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the task should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Task will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -These alternative syntaxes are available. They will set the given values to `cmds` and everything else will be set to their default values: - -```yaml -tasks: - foo: echo "foo" - - foobar: - - echo "foo" - - echo "bar" - - baz: - cmd: echo "baz" -``` - -::: - -#### Command - -| Attribute | Type | Default | Description | -| -------------- | ---------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmd` | `string` | | The shell command to be executed. | -| `task` | `string` | | Set this to trigger execution of another task instead of running a command. This cannot be set together with `cmd`. | -| `for` | [`For`](#for) | | Runs the command once for each given value. | -| `silent` | `bool` | `false` | Skips some output for this command. Note that STDOUT and STDERR of the commands will still be redirected. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to the referenced task. Only relevant when setting `task` instead of `cmd`. | -| `ignore_error` | `bool` | `false` | Continue execution if errors happen while executing the command. | -| `defer` | `string` | | Alternative to `cmd`, but schedules the command to be executed at the end of this task instead of immediately. This cannot be used together with `cmd`. | -| `platforms` | `[]string` | All platforms | Specifies which platforms the command should be run on. [Valid GOOS and GOARCH values allowed](https://github.com/golang/go/blob/main/src/go/build/syslist.go). Command will be skipped otherwise. | -| `set` | `[]string` | | Specify options for the [`set` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html). | -| `shopt` | `[]string` | | Specify option for the [`shopt` builtin](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). | - -:::info - -If given as a a string, the value will be assigned to `cmd`: - -```yaml -tasks: - foo: - cmds: - - echo "foo" - - echo "bar" -``` - -::: - -#### Dependency - -| Attribute | Type | Default | Description | -| --------- | ---------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------- | -| `task` | `string` | | The task to be execute as a dependency. | -| `vars` | [`map[string]Variable`](#variable) | | Optional additional variables to be passed to this task. | -| `silent` | `bool` | `false` | Hides task name and command from output. The command's output will still be redirected to `STDOUT` and `STDERR`. | - -:::tip - -If you don't want to set additional variables, it's enough to declare the dependency as a list of strings (they will be assigned to `task`): - -```yaml -tasks: - foo: - deps: [foo, bar] -``` - -::: - -#### For - -The `for` parameter can be defined as a string, a list of strings or a map. If it is defined as a string, you can give it any of the following values: - -- `source` - Will run the command for each source file defined on the task. (Glob patterns will be resolved, so `*.go` will run for every Go file that matches). - -If it is defined as a list of strings, the command will be run for each value. - -Finally, the `for` parameter can be defined as a map when you want to use a variable to define the values to loop over: - -| Attribute | Type | Default | Description | -| --------- | -------- | ---------------- | -------------------------------------------- | -| `var` | `string` | | The name of the variable to use as an input. | -| `split` | `string` | (any whitespace) | What string the variable should be split on. | -| `as` | `string` | `ITEM` | The name of the iterator variable. | - -#### Precondition - -| Attribute | Type | Default | Description | -| --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | -| `sh` | `string` | | Command to be executed. If a non-zero exit code is returned, the task errors without executing its commands. | -| `msg` | `string` | | Optional message to print if the precondition isn't met. | - -:::tip - -If you don't want to set a different message, you can declare a precondition like this and the value will be assigned to `sh`: - -```yaml -tasks: - foo: - precondition: test -f Taskfile.yml -``` - -::: - -#### Requires - -| Attribute | Type | Default | Description | -| --------- | ---------- | ------- | -------------------------------------------------------------------------------------------------- | -| `vars` | `[]string` | | List of variable or environment variable names that must be set if this task is to execute and run | diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/changelog.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/changelog.md deleted file mode 100644 index 628d35e1..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/changelog.md +++ /dev/null @@ -1,573 +0,0 @@ ---- -slug: /changelog/ -sidebar_position: 14 ---- - -# Changelog - -## v3.33.1 - 2023-12-21 - -- Added support for looping over map variables with the [Any Variables experiment](https://taskfile.dev/experiments/any_variables) enabled (#1435, #1437 by @pd93). -- Fixed a bug where dynamic variables were causing errors during fast compilation (#1435, #1437 by @pd93) - -## v3.33.0 - 2023-12-20 - -- Added [Any Variables experiment](https://taskfile.dev/experiments/any-variables) (#1415, #1421 by @pd93). -- Updated Docusaurus to v3 (#1432 by @pd93). -- Added `aliases` to `--json` flag output (#1430, #1431 by @pd93). -- Added new `CLI_FORCE` special variable containing whether the `--force` or `--force-all` flags were set (#1412, #1434 by @pd93). - -## v3.32.0 - 2023-11-29 - -- Added ability to exclude some files from `sources:` by using `exclude:` (#225, - - # 1324 by @pd93 and @andreynering). -- The [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) now prefers remote files over cached ones by default (#1317, #1345 by @pd93). -- Added `--timeout` flag to the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1345 by @pd93). -- Fix bug where dynamic `vars:` and `env:` were being executed when they should actually be skipped by `platforms:` (#1273, #1377 by @andreynering). -- Fix `schema.json` to make `silent` valid in `cmds` that use `for` (#1385, - - # 1386 by @iainvm). -- Add new `--no-status` flag to skip expensive status checks when running `task --list --json` (#1348, #1368 by @amancevice). - -## v3.31.0 - 2023-10-07 - -- Enabled the `--yes` flag for the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1344 by @pd93). -- Add ability to set `watch: true` in a task to automatically run it in watch mode (#231, #1361 by @andreynering). -- Fixed a bug on the watch mode where paths that contained `.git` (like `.github`), for example, were also being ignored (#1356 by @butuzov). -- Fixed a nil pointer error when running a Taskfile with no contents (#1341, - - # 1342 by @pd93). -- Added a new [exit code](https://taskfile.dev/api/#exit-codes) (107) for when a Taskfile does not contain a schema version (#1342 by @pd93). -- Increased limit of maximum task calls from 100 to 1000 for now, as some people have been reaching this limit organically now that we have loops. This check exists to detect recursive calls, but will be removed in favor of a better algorithm soon (#1321, #1332). -- Fixed templating on descriptions on `task --list` (#1343 by @blackjid). -- Fixed a bug where precondition errors were incorrectly being printed when task execution was aborted (#1337, #1338 by @sylv-io). - -## v3.30.1 - 2023-09-14 - -- Fixed a regression where some special variables weren't being set correctly (#1331, #1334 by @pd93). - -## v3.30.0 - 2023-09-13 - -- Prep work for Remote Taskfiles (#1316 by @pd93). -- Added the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) as a draft (#1152, #1317 by @pd93). -- Improve performance of content checksuming on `sources:` by replacing md5 with [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking change because checksums will be invalidated when upgrading to this release (#1325 by @ReillyBrogan). - -## v3.29.1 - 2023-08-26 - -- Update to Go 1.21 (bump minimum version to 1.20) (#1302 by @pd93) -- Fix a missing a line break on log when using `--watch` mode (#1285, #1297 by @FilipSolich). -- Fix `defer` on JSON Schema (#1288 by @calvinmclean and @andreynering). -- Fix bug in usage of special variables like `{{.USER_WORKING_DIR}}` in combination with `includes` (#1046, #1205, #1250, #1293, #1312, #1274 by @andarto, #1309 by @andreynering). -- Fix bug on `--status` flag. Running this flag should not have side-effects: it should not update the checksum on `.task`, only report its status (#1305, - - # 1307 by @visciang, #1313 by @andreynering). - -## v3.28.0 - 2023-07-24 - -- Added the ability to [loop over commands and tasks](https://taskfile.dev/usage/#looping-over-values) using `for` (#82, #1220 by @pd93). -- Fixed variable propagation in multi-level includes (#778, #996, #1256 by @hudclark). -- Fixed a bug where the `--exit-code` code flag was not returning the correct exit code when calling commands indirectly (#1266, #1270 by @pd93). -- Fixed a `nil` panic when a dependency was commented out or left empty (#1263 by @neomantra). - -## v3.27.1 - 2023-06-30 - -- Fix panic when a `.env` directory (not file) is present on current directory (#1244, #1245 by @pd93). - -## v3.27.0 - 2023-06-29 - -- Allow Taskfiles starting with lowercase characters (#947, #1221 by @pd93). - - e.g. `taskfile.yml`, `taskfile.yaml`, `taskfile.dist.yml` & `taskfile.dist.yaml` -- Bug fixes were made to the [npm installation method](https://taskfile.dev/installation/#npm). (#1190, by @sounisi5011). -- Added the [gentle force experiment](https://taskfile.dev/experiments/gentle-force) as a draft (#1200, #1216 by @pd93). -- Added an `--experiments` flag to allow you to see which experiments are enabled (#1242 by @pd93). -- Added ability to specify which variables are required in a task (#1203, #1204 by @benc-uk). - -## v3.26.0 - 2023-06-10 - -- Only rewrite checksum files in `.task` if the checksum has changed (#1185, - - # 1194 by @deviantintegral). -- Added [experiments documentation](https://taskfile.dev/experiments) to the website (#1198 by @pd93). -- Deprecated `version: 2` schema. This will be removed in the next major release (#1197, #1198, #1199 by @pd93). -- Added a new `prompt:` prop to set a warning prompt to be shown before running a potential dangurous task (#100, #1163 by @MaxCheetham, [Documentation](https://taskfile.dev/usage/#warning-prompts)). -- Added support for single command task syntax. With this change, it's now possible to declare just `cmd:` in a task, avoiding the more complex `cmds: []` when you have only a single command for that task (#1130, #1131 by @timdp). - -## v3.25.0 - 2023-05-22 - -- Support `silent:` when calling another tasks (#680, #1142 by @danquah). -- Improve PowerShell completion script (#1168 by @trim21). -- Add more languages to the website menu and show translation progress percentage (#1173 by @misitebao). -- Starting on this release, official binaries for FreeBSD will be available to download (#1068 by @andreynering). -- Fix some errors being unintendedly supressed (#1134 by @clintmod). -- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - - # 1149 by @pd93). -- Fix duplicate error message when a task does not exists (#1141, #1144 by @pd93). - -## v3.24.0 - 2023-04-15 - -- Fix Fish shell completion for tasks with aliases (#1113 by @patricksjackson). -- The default branch was renamed from `master` to `main` (#1049, #1048 by @pd93). -- Fix bug where "up-to-date" logs were not being omitted for silent tasks (#546, - - # 1107 by @danquah). -- Add `.hg` (Mercurial) to the list of ignored directories when using `--watch` (#1098 by @misery). -- More improvements to the release tool (#1096 by @pd93). -- Enforce [gofumpt](https://github.com/mvdan/gofumpt) linter (#1099 by @pd93) -- Add `--sort` flag for use with `--list` and `--list-all` (#946, #1105 by @pd93). -- Task now has [custom exit codes](https://taskfile.dev/api/#exit-codes) depending on the error (#1114 by @pd93). - -## v3.23.0 - 2023-03-26 - -Task now has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task) contributed by @pd93! :tada: The extension is maintained in a [new repository](https://github.com/go-task/vscode-task) under the `go-task` organization. We're looking to gather feedback from the community so please give it a go and let us know what you think via a [discussion](https://github.com/go-task/vscode-task/discussions), [issue](https://github.com/go-task/vscode-task/issues) or on our [Discord](https://discord.gg/6TY36E39UK)! - -> **NOTE:** The extension _requires_ v3.23.0 to be installed in order to work. - -- The website was integrated with [Crowdin](https://crowdin.com/project/taskfile) to allow the community to contribute with translations! [Chinese](https://taskfile.dev/zh-Hans/) is the first language available (#1057, #1058 by @misitebao). -- Added task location data to the `--json` flag output (#1056 by @pd93) -- Change the name of the file generated by `task --init` from `Taskfile.yaml` to `Taskfile.yml` (#1062 by @misitebao). -- Added new `splitArgs` template function (`{{splitArgs "foo bar 'foo bar baz'"}}`) to ensure string is split as arguments (#1040, #1059 by @dhanusaputra). -- Fix the value of `{{.CHECKSUM}}` variable in status (#1076, #1080 by @pd93). -- Fixed deep copy implementation (#1072 by @pd93) -- Created a tool to assist with releases (#1086 by @pd93). - -## v3.22.0 - 2023-03-10 - -- Add a brand new `--global` (`-g`) flag that will run a Taskfile from your `$HOME` directory. This is useful to have automation that you can run from anywhere in your system! ([Documentation](https://taskfile.dev/usage/#running-a-global-taskfile), #1029 by @andreynering). -- Add ability to set `error_only: true` on the `group` output mode. This will instruct Task to only print a command output if it returned with a non-zero exit code (#664, #1022 by @jaedle). -- Fixed bug where `.task/checksum` file was sometimes not being created when task also declares a `status:` (#840, #1035 by @harelwa, #1037 by @pd93). -- Refactored and decoupled fingerprinting from the main Task executor (#1039 by @pd93). -- Fixed deadlock issue when using `run: once` (#715, #1025 by @theunrepentantgeek). - -## v3.21.0 - 2023-02-22 - -- Added new `TASK_VERSION` special variable (#990, #1014 by @ja1code). -- Fixed a bug where tasks were sometimes incorrectly marked as internal (#1007 by @pd93). -- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) -- Added environment variable `FORCE_COLOR` support to force color output. Usefull for environments without TTY (#1003 by @automation-stack) - -## v3.20.0 - 2023-01-14 - -- Improve behavior and performance of status checking when using the `timestamp` mode (#976, #977 by @aminya). -- Performance optimizations were made for large Taskfiles (#982 by @pd93). -- Add ability to configure options for the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins (#908, #929 by @pd93, [Documentation](http://taskfile.dev/usage/#set-and-shopt)). -- Add new `platforms:` attribute to `task` and `cmd`, so it's now possible to choose in which platforms that given task or command will be run on. Possible values are operating system (GOOS), architecture (GOARCH) or a combination of the two. Example: `platforms: [linux]`, `platforms: [amd64]` or `platforms: [linux/amd64]`. Other platforms will be skipped (#978, #980 by @leaanthony). - -## v3.19.1 - 2022-12-31 - -- Small bug fix: closing `Taskfile.yml` once we're done reading it (#963, #964 by @HeCorr). -- Fixes a bug in v2 that caused a panic when using a `Taskfile_{{OS}}.yml` file (#961, #971 by @pd93). -- Fixed a bug where watch intervals set in the Taskfile were not being respected (#969, #970 by @pd93) -- Add `--json` flag (alias `-j`) with the intent to improve support for code editors and add room to other possible integrations. This is basic for now, but we plan to add more info in the near future (#936 by @davidalpert, #764). - -## v3.19.0 - 2022-12-05 - -- Installation via npm now supports [pnpm](https://pnpm.io/) as well ([go-task/go-npm#2](https://github.com/go-task/go-npm/issues/2), [go-task/go-npm#3](https://github.com/go-task/go-npm/pull/3)). -- It's now possible to run Taskfiles from subdirectories! A new `USER_WORKING_DIR` special variable was added to add even more flexibility for monorepos (#289, #920). -- Add task-level `dotenv` support (#389, #904). -- It's now possible to use global level variables on `includes` (#942, #943). -- The website got a brand new [translation to Chinese](https://task-zh.readthedocs.io/zh_CN/latest/) by [@DeronW](https://github.com/DeronW). Thanks! - -## v3.18.0 - 2022-11-12 - -- Show aliases on `task --list --silent` (`task --ls`). This means that aliases will be completed by the completion scripts (#919). -- Tasks in the root Taskfile will now be displayed first in `--list`/`--list-all` output (#806, #890). -- It's now possible to call a `default` task in an included Taskfile by using just the namespace. For example: `docs:default` is now automatically aliased to `docs` (#661, #815). - -## v3.17.0 - 2022-10-14 - -- Add a "Did you mean ...?" suggestion when a task does not exits another one with a similar name is found (#867, #880). -- Now YAML parse errors will print which Taskfile failed to parse (#885, #887). -- Add ability to set `aliases` for tasks and namespaces (#268, #340, #879). -- Improvements to Fish shell completion (#897). -- Added ability to set a different watch interval by setting `interval: '500ms'` or using the `--interval=500ms` flag (#813, #865). -- Add colored output to `--list`, `--list-all` and `--summary` flags (#845, - - # 874). -- Fix unexpected behavior where `label:` was being shown instead of the task name on `--list` (#603, #877). - -## v3.16.0 - 2022-09-29 - -- Add `npm` as new installation method: `npm i -g @go-task/cli` (#870, #871, [npm package](https://www.npmjs.com/package/@go-task/cli)). -- Add support to marking tasks and includes as internal, which will hide them from `--list` and `--list-all` (#818). - -## v3.15.2 - 2022-09-08 - -- Fix error when using variable in `env:` introduced in the previous release (#858, #866). -- Fix handling of `CLI_ARGS` (`--`) in Bash completion (#863). -- On zsh completion, add ability to replace `--list-all` with `--list` as already possible on the Bash completion (#861). - -## v3.15.0 - 2022-09-03 - -- Add new special variables `ROOT_DIR` and `TASKFILE_DIR`. This was a highly requested feature (#215, #857, [Documentation](https://taskfile.dev/api/#special-variables)). -- Follow symlinks on `sources` (#826, #831). -- Improvements and fixes to Bash completion (#835, #844). - -## v3.14.1 - 2022-08-03 - -- Always resolve relative include paths relative to the including Taskfile (#822, #823). -- Fix ZSH and PowerShell completions to consider all tasks instead of just the public ones (those with descriptions) (#803). - -## v3.14.0 - 2022-07-08 - -- Add ability to override the `.task` directory location with the `TASK_TEMP_DIR` environment variable. -- Allow to override Task colors using environment variables: `TASK_COLOR_RESET`, `TASK_COLOR_BLUE`, `TASK_COLOR_GREEN`, `TASK_COLOR_CYAN`, `TASK_COLOR_YELLOW`, `TASK_COLOR_MAGENTA` and `TASK_COLOR_RED` (#568, #792). -- Fixed bug when using the `output: group` mode where STDOUT and STDERR were being print in separated blocks instead of in the right order (#779). -- Starting on this release, ARM architecture binaries are been released to Snap as well (#795). -- i386 binaries won't be available anymore on Snap because Ubuntu removed the support for this architecture. -- Upgrade mvdan.cc/sh, which fixes a bug with associative arrays (#785, [mvdan/sh#884](https://github.com/mvdan/sh/issues/884), [mvdan/sh#893](https://github.com/mvdan/sh/pull/893)). - -## v3.13.0 - 2022-06-13 - -- Added `-n` as an alias to `--dry` (#776, #777). -- Fix behavior of interrupt (SIGINT, SIGTERM) signals. Task will now give time for the processes running to do cleanup work (#458, #479, #728, #769). -- Add new `--exit-code` (`-x`) flag that will pass-through the exit form the command being ran (#755). - -## v3.12.1 - 2022-05-10 - -- Fixed bug where, on Windows, variables were ending with `\r` because we were only removing the final `\n` but not `\r\n` (#717). - -## v3.12.0 - 2022-03-31 - -- The `--list` and `--list-all` flags can now be combined with the `--silent` flag to print the task names only, without their description (#691). -- Added support for multi-level inclusion of Taskfiles. This means that included Taskfiles can also include other Taskfiles. Before this was limited to one level (#390, #623, #656). -- Add ability to specify vars when including a Taskfile. [Check out the documentation](https://taskfile.dev/#/usage?id=vars-of-included-taskfiles) for more information (#677). - -## v3.11.0 - 2022-02-19 - -- Task now supports printing begin and end messages when using the `group` output mode, useful for grouping tasks in CI systems. [Check out the documentation](http://taskfile.dev/#/usage?id=output-syntax) for more information (#647, #651). -- Add `Taskfile.dist.yml` and `Taskfile.dist.yaml` to the supported file name list. [Check out the documentation](https://taskfile.dev/#/usage?id=supported-file-names) for more information (#498, #666). - -## v3.10.0 - 2022-01-04 - -- A new `--list-all` (alias `-a`) flag is now available. It's similar to the exiting `--list` (`-l`) but prints all tasks, even those without a description (#383, #401). -- It's now possible to schedule cleanup commands to run once a task finishes with the `defer:` keyword ([Documentation](https://taskfile.dev/#/usage?id=doing-task-cleanup-with-defer), - - # 475, #626). -- Remove long deprecated and undocumented `$` variable prefix and `^` command prefix (#642, #644, #645). -- Add support for `.yaml` extension (as an alternative to `.yml`). This was requested multiple times throughout the years. Enjoy! (#183, #184, #369, #584, - - # 621). -- Fixed error when computing a variable when the task directory do not exist yet (#481, #579). - -## v3.9.2 - 2021-12-02 - -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains a fix a for a important regression on Windows (#619, [mvdan/sh#768](https://github.com/mvdan/sh/issues/768), [mvdan/sh#769](https://github.com/mvdan/sh/pull/769)). - -## v3.9.1 - 2021-11-28 - -- Add logging in verbose mode for when a task starts and finishes (#533, #588). -- Fix an issue with preconditions and context errors (#597, #598). -- Quote each `{{.CLI_ARGS}}` argument to prevent one with spaces to become many (#613). -- Fix nil pointer when `cmd:` was left empty (#612, #614). -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains two relevant fixes: - - Fix quote of empty strings in `shellQuote` (#609, [mvdan/sh#763](https://github.com/mvdan/sh/issues/763)). - - Fix issue of wrong environment variable being picked when there's another very similar one (#586, [mvdan/sh#745](https://github.com/mvdan/sh/pull/745)). -- Install shell completions automatically when installing via Homebrew (#264, #592, [go-task/homebrew-tap#2](https://github.com/go-task/homebrew-tap/pull/2)). - -## v3.9.0 - 2021-10-02 - -- A new `shellQuote` function was added to the template system (`{{shellQuote "a string"}}`) to ensure a string is safe for use in shell ([mvdan/sh#727](https://github.com/mvdan/sh/pull/727), [mvdan/sh#737](https://github.com/mvdan/sh/pull/737), [Documentation](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)) -- In this version [mvdan.cc/sh](https://github.com/mvdan/sh) was upgraded with some small fixes and features - - The `read -p` flag is now supported (#314, [mvdan/sh#551](https://github.com/mvdan/sh/issues/551), [mvdan/sh#772](https://github.com/mvdan/sh/pull/722)) - - The `pwd -P` and `pwd -L` flags are now supported (#553, [mvdan/sh#724](https://github.com/mvdan/sh/issues/724), [mvdan/sh#728](https://github.com/mvdan/sh/pull/728)) - - The `$GID` environment variable is now correctly being set (#561, [mvdan/sh#723](https://github.com/mvdan/sh/pull/723)) - -## v3.8.0 - 2021-09-26 - -- Add `interactive: true` setting to improve support for interactive CLI apps (#217, #563). -- Fix some `nil` errors (#534, #573). -- Add ability to declare an included Taskfile as optional (#519, #552). -- Add support for including Taskfiles in the home directory by using `~` (#539, #557). - -## v3.7.3 - 2021-09-04 - -- Add official support to Apple M1 (#564, #567). -- Our [official Homebrew tap](https://github.com/go-task/homebrew-tap) will support more platforms, including Apple M1 - -## v3.7.0 - 2021-07-31 - -- Add `run:` setting to control if tasks should run multiple times or not. Available options are `always` (the default), `when_changed` (if a variable modified the task) and `once` (run only once no matter what). This is a long time requested feature. Enjoy! (#53, #359). - -## v3.6.0 - 2021-07-10 - -- Allow using both `sources:` and `status:` in the same task (#411, #427, #477). -- Small optimization and bug fix: don't compute variables if not needed for `dotenv:` (#517). - -## v3.5.0 - 2021-07-04 - -- Add support for interpolation in `dotenv:` (#433, #434, #453). - -## v3.4.3 - 2021-05-30 - -- Add support for the `NO_COLOR` environment variable. (#459, [fatih/color#137](https://github.com/fatih/color/pull/137)). -- Fix bug where sources were not considering the right directory in `--watch` mode (#484, #485). - -## v3.4.2 - 2021-04-23 - -- On watch, report which file failed to read (#472). -- Do not try to catch SIGKILL signal, which are not actually possible (#476). -- Improve version reporting when building Task from source using Go Modules (#462, #473). - -## v3.4.1 - 2021-04-17 - -- Improve error reporting when parsing YAML: in some situations where you would just see an generic error, you'll now see the actual error with more detail: the YAML line the failed to parse, for example (#467). -- A JSON Schema was published [here](https://json.schemastore.org/taskfile.json) and is automatically being used by some editors like Visual Studio Code (#135). -- Print task name before the command in the log output (#398). - -## v3.3.0 - 2021-03-20 - -- Add support for delegating CLI arguments to commands with `--` and a special `CLI_ARGS` variable (#327). -- Add a `--concurrency` (alias `-C`) flag, to limit the number of tasks that run concurrently. This is useful for heavy workloads. (#345). - -## v3.2.2 - 2021-01-12 - -- Improve performance of `--list` and `--summary` by skipping running shell variables for these flags (#332). -- Fixed a bug where an environment in a Taskfile was not always overridable by the system environment (#425). -- Fixed environment from .env files not being available as variables (#379). -- The install script is now working for ARM platforms (#428). - -## v3.2.1 - 2021-01-09 - -- Fixed some bugs and regressions regarding dynamic variables and directories (#426). -- The [slim-sprig](https://github.com/go-task/slim-sprig) package was updated with the upstream [sprig](https://github.com/Masterminds/sprig). - -## v3.2.0 - 2021-01-07 - -- Fix the `.task` directory being created in the task directory instead of the Taskfile directory (#247). -- Fix a bug where dynamic variables (those declared with `sh:`) were not running in the task directory when the task has a custom dir or it was in an included Taskfile (#384). -- The watch feature (via the `--watch` flag) got a few different bug fixes and should be more stable now (#423, #365). - -## v3.1.0 - 2021-01-03 - -- Fix a bug when the checksum up-to-date resolution is used by a task with a custom `label:` attribute (#412). -- Starting from this release, we're releasing official ARMv6 and ARM64 binaries for Linux (#375, #418). -- Task now respects the order of declaration of included Taskfiles when evaluating variables declaring by them (#393). -- `set -e` is now automatically set on every command. This was done to fix an issue where multiline string commands wouldn't really fail unless the sentence was in the last line (#403). - -## v3.0.1 - 2020-12-26 - -- Allow use as a library by moving the required packages out of the `internal` directory (#358). -- Do not error if a specified dotenv file does not exist (#378, #385). -- Fix panic when you have empty tasks in your Taskfile (#338, #362). - -## v3.0.0 - 2020-08-16 - -- On `v3`, all CLI variables will be considered global variables (#336, #341) -- Add support to `.env` like files (#324, #356). -- Add `label:` to task so you can override the task name in the logs (#321, - - # 337). -- Refactor how variables work on version 3 (#311). -- Disallow `expansions` on v3 since it has no effect. -- `Taskvars.yml` is not automatically included anymore. -- `Taskfile_{{OS}}.yml` is not automatically included anymore. -- Allow interpolation on `includes`, so you can manually include a Taskfile based on operation system, for example. -- Expose `.TASK` variable in templates with the task name (#252). -- Implement short task syntax (#194, #240). -- Added option to make included Taskfile run commands on its own directory (#260, #144) -- Taskfiles in version 1 are not supported anymore (#237). -- Added global `method:` option. With this option, you can set a default method to all tasks in a Taskfile (#246). -- Changed default method from `timestamp` to `checksum` (#246). -- New magic variables are now available when using `status:`: `.TIMESTAMP` which contains the greatest modification date from the files listed in `sources:`, and `.CHECKSUM`, which contains a checksum of all files listed in `status:`. This is useful for manual checking when using external, or even remote, artifacts when using `status:` (#216). -- We're now using [slim-sprig](https://github.com/go-task/slim-sprig) instead of [sprig](https://github.com/Masterminds/sprig), which allowed a file size reduction of about 22% (#219). -- We now use some colors on Task output to better distinguish message types - commands are green, errors are red, etc (#207). - -## v2.8.1 - 2020-05-20 - -- Fix error code for the `--help` flag (#300, #330). -- Print version to stdout instead of stderr (#299, #329). -- Supress `context` errors when using the `--watch` flag (#313, #317). -- Support templating on description (#276, #283). - -## v2.8.0 - 2019-12-07 - -- Add `--parallel` flag (alias `-p`) to run tasks given by the command line in parallel (#266). -- Fixed bug where calling the `task` CLI only informing global vars would not execute the `default` task. -- Add hability to silent all tasks by adding `silent: true` a the root of the Taskfile. - -## v2.7.1 - 2019-11-10 - -- Fix error being raised when `exit 0` was called (#251). - -## v2.7.0 - 2019-09-22 - -- Fixed panic bug when assigning a global variable (#229, #243). -- A task with `method: checksum` will now re-run if generated files are deleted (#228, #238). - -## v2.6.0 - 2019-07-21 - -- Fixed some bugs regarding minor version checks on `version:`. -- Add `preconditions:` to task (#205). -- Create directory informed on `dir:` if it doesn't exist (#209, #211). -- We now have a `--taskfile` flag (alias `-t`), which can be used to run another Taskfile (other than the default `Taskfile.yml`) (#221). -- It's now possible to install Task using Homebrew on Linux ([go-task/homebrew-tap#1](https://github.com/go-task/homebrew-tap/pull/1)). - -## v2.5.2 - 2019-05-11 - -- Reverted YAML upgrade due issues with CRLF on Windows (#201, [go-yaml/yaml#450](https://github.com/go-yaml/yaml/issues/450)). -- Allow setting global variables through the CLI (#192). - -## 2.5.1 - 2019-04-27 - -- Fixed some issues with interactive command line tools, where sometimes the output were not being shown, and similar issues (#114, #190, #200). -- Upgraded [go-yaml/yaml](https://github.com/go-yaml/yaml) from v2 to v3. - -## v2.5.0 - 2019-03-16 - -- We moved from the taskfile.org domain to the new fancy taskfile.dev domain. While stuff is being redirected, we strongly recommend to everyone that use [this install script](https://taskfile.dev/#/installation?id=install-script) to use the new taskfile.dev domain on scripts from now on. -- Fixed to the ZSH completion (#182). -- Add [`--summary` flag along with `summary:` task attribute](https://taskfile.org/#/usage?id=display-summary-of-task) (#180). - -## v2.4.0 - 2019-02-21 - -- Allow calling a task of the root Taskfile from an included Taskfile by prefixing it with `:` (#161, #172). -- Add flag to override the `output` option (#173). -- Fix bug where Task was persisting the new checksum on the disk when the Dry Mode is enabled (#166). -- Fix file timestamp issue when the file name has spaces (#176). -- Mitigating path expanding issues on Windows (#170). - -## v2.3.0 - 2019-01-02 - -- On Windows, Task can now be installed using [Scoop](https://scoop.sh/) (#152). -- Fixed issue with file/directory globing (#153). -- Added ability to globally set environment variables (#138, #159). - -## v2.2.1 - 2018-12-09 - -- This repository now uses Go Modules (#143). We'll still keep the `vendor` directory in sync for some time, though; -- Fixing a bug when the Taskfile has no tasks but includes another Taskfile (#150); -- Fix a bug when calling another task or a dependency in an included Taskfile (#151). - -## v2.2.0 - 2018-10-25 - -- Added support for [including other Taskfiles](https://taskfile.org/#/usage?id=including-other-taskfiles) (#98) - - This should be considered experimental. For now, only including local files is supported, but support for including remote Taskfiles is being discussed. If you have any feedback, please comment on #98. -- Task now have a dedicated documentation site: https://taskfile.org - - Thanks to [Docsify](https://docsify.js.org/) for making this pretty easy. To check the source code, just take a look at the [docs](https://github.com/go-task/task/tree/main/docs) directory of this repository. Contributions to the documentation is really appreciated. - -## v2.1.1 - 2018-09-17 - -- Fix suggestion to use `task --init` not being shown anymore (when a `Taskfile.yml` is not found) -- Fix error when using checksum method and no file exists for a source glob (#131) -- Fix signal handling when the `--watch` flag is given (#132) - -## v2.1.0 - 2018-08-19 - -- Add a `ignore_error` option to task and command (#123) -- Add a dry run mode (`--dry` flag) (#126) - -## v2.0.3 - 2018-06-24 - -- Expand environment variables on "dir", "sources" and "generates" (#116) -- Fix YAML merging syntax (#112) -- Add ZSH completion (#111) -- Implement new `output` option. Please check out the [documentation](https://github.com/go-task/task#output-syntax) - -## v2.0.2 - 2018-05-01 - -- Fix merging of YAML anchors (#112) - -## v2.0.1 - 2018-03-11 - -- Fixes panic on `task --list` - -## v2.0.0 - 2018-03-08 - -Version 2.0.0 is here, with a new Taskfile format. - -Please, make sure to read the [Taskfile versions](https://github.com/go-task/task/blob/main/TASKFILE_VERSIONS.md) document, since it describes in depth what changed for this version. - -- New Taskfile version 2 (#77) -- Possibility to have global variables in the `Taskfile.yml` instead of `Taskvars.yml` (#66) -- Small improvements and fixes - -## v1.4.4 - 2017-11-19 - -- Handle SIGINT and SIGTERM (#75); -- List: print message with there's no task with description; -- Expand home dir ("~" symbol) on paths (#74); -- Add Snap as an installation method; -- Move examples to its own repo; -- Watch: also walk on tasks called on on "cmds", and not only on "deps"; -- Print logs to stderr instead of stdout (#68); -- Remove deprecated `set` keyword; -- Add checksum based status check, alternative to timestamp based. - -## v1.4.3 - 2017-09-07 - -- Allow assigning variables to tasks at run time via CLI (#33) -- Added suport for multiline variables from sh (#64) -- Fixes env: remove square braces and evaluate shell (#62) -- Watch: change watch library and few fixes and improvements -- When use watching, cancel and restart long running process on file change (#59 and #60) - -## v1.4.2 - 2017-07-30 - -- Flag to set directory of execution -- Always echo command if is verbose mode -- Add silent mode to disable echoing of commands -- Fixes and improvements of variables (#56) - -## v1.4.1 - 2017-07-15 - -- Allow use of YAML for dynamic variables instead of $ prefix - - `VAR: {sh: echo Hello}` instead of `VAR: $echo Hello` -- Add `--list` (or `-l`) flag to print existing tasks -- OS specific Taskvars file (e.g. `Taskvars_windows.yml`, `Taskvars_linux.yml`, etc) -- Consider task up-to-date on equal timestamps (#49) -- Allow absolute path in generates section (#48) -- Bugfix: allow templating when calling deps (#42) -- Fix panic for invalid task in cyclic dep detection -- Better error output for dynamic variables in Taskvars.yml (#41) -- Allow template evaluation in parameters - -## v1.4.0 - 2017-07-06 - -- Cache dynamic variables -- Add verbose mode (`-v` flag) -- Support to task parameters (overriding vars) (#31) (#32) -- Print command, also when "set:" is specified (#35) -- Improve task command help text (#35) - -## v1.3.1 - 2017-06-14 - -- Fix glob not working on commands (#28) -- Add ExeExt template function -- Add `--init` flag to create a new Taskfile -- Add status option to prevent task from running (#27) -- Allow interpolation on `generates` and `sources` attributes (#26) - -## v1.3.0 - 2017-04-24 - -- Migrate from os/exec.Cmd to a native Go sh/bash interpreter - - This is a potentially breaking change if you use Windows. - - Now, `cmd` is not used anymore on Windows. Always use Bash-like syntax for your commands, even on Windows. -- Add "ToSlash" and "FromSlash" to template functions -- Use functions defined on github.com/Masterminds/sprig -- Do not redirect stdin while running variables commands -- Using `context` and `errgroup` packages (this will make other tasks to be cancelled, if one returned an error) - -## v1.2.0 - 2017-04-02 - -- More tests and Travis integration -- Watch a task (experimental) -- Possibility to call another task -- Fix "=" not being reconized in variables/environment variables -- Tasks can now have a description, and help will print them (#10) -- Task dependencies now run concurrently -- Support for a default task (#16) - -## v1.1.0 - 2017-03-08 - -- Support for YAML, TOML and JSON (#1) -- Support running command in another directory (#4) -- `--force` or `-f` flag to force execution of task even when it's up-to-date -- Detection of cyclic dependencies (#5) -- Support for variables (#6, #9, #14) -- Operation System specific commands and variables (#13) - -## v1.0.0 - 2017-02-28 - -- Add LICENSE file diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/community.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/community.md deleted file mode 100644 index c069c2be..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/community.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -slug: /community/ -sidebar_position: 9 ---- - -# Community - -Some of the work to improve the Task ecosystem is done by the community, be it installation methods or integrations with code editor. I (the author) am thankful for everyone that helps me to improve the overall experience. - -## Translations - -We use [Crowdin](https://crowdin.com/project/taskfile) to translate our document. - -## Integrations - -Many of our integrations are contributed and maintained by the community. You can view the full list of community integrations [here](/integrations#community-integrations). - -## Installation methods - -Some installation methods are maintained by third party: - -- [GitHub Actions](https://github.com/arduino/setup-task) by @arduino -- [AUR](https://aur.archlinux.org/packages/go-task-bin) by @carlsmedstad -- [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json) -- [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) -- [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/go-task/default.nix) -- [Conda](https://github.com/conda-forge/go-task-feedstock/) - -## More - -Also, thanks for all the [code contributors](https://github.com/go-task/task/graphs/contributors), [financial contributors](https://opencollective.com/task), all those who [reported bugs](https://github.com/go-task/task/issues?q=is%3Aissue) and [answered questions](https://github.com/go-task/task/discussions). - -If you know something that is missing in this document, please submit a pull request. diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/contributing.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/contributing.md deleted file mode 100644 index 57b2aa7b..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/contributing.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -slug: /contributing/ -sidebar_position: 11 ---- - -# Contributing - -Contributions to Task are very welcome, but we ask that you read this document before submitting a PR. - -:::note - -This document applies to the core [Task][task] repository _and_ [Task for Visual Studio Code][vscode-task]. - -::: - -## Before you start - -- **Check existing work** - Is there an existing PR? Are there issues discussing the feature/change you want to make? Please make sure you consider/address these discussions in your work. -- **Backwards compatibility** - Will your change break existing Taskfiles? It is much more likely that your change will merged if it backwards compatible. Is there an approach you can take that maintains this compatibility? If not, consider opening an issue first so that API changes can be discussed before you invest your time into a PR. -- **Experiments** - If there is no way to make your change backward compatible then there is a procedure to introduce breaking changes into minor versions. We call these "\[experiments\]\[experiments\]". If you're intending to work on an experiment, then please read the \[experiments workflow\]\[experiments-workflow\] document carefully and submit a proposal first. - -## 1. Setup - -- **Go** - Task is written in [Go][go]. We always support the latest two major Go versions, so make sure your version is recent enough. -- **Node.js** - [Node.js][nodejs] is used to host Task's documentation server and is required if you want to run this server locally. It is also required if you want to contribute to the Visual Studio Code extension. -- **Yarn** - [Yarn][yarn] is the Node.js package manager used by Task. - -## 2. Making changes - -- **Code style** - Try to maintain the existing code style where possible. Go code should be formatted by [`gofumpt`][gofumpt] and linted using [`golangci-lint`][golangci-lint]. Any Markdown or TypeScript files should be formatted and linted by [Prettier][prettier]. This style is enforced by our CI to ensure that we have a consistent style across the project. You can use the `task lint` command to lint the code locally and the `task lint:fix` command to automatically fix any issues that are found. -- **Documentation** - Ensure that you add/update any relevant documentation. See the [updating documentation](#updating-documentation) section below. -- **Tests** - Ensure that you add/update any relevant tests and that all tests are passing before submitting the PR. See the [writing tests](#writing-tests) section below. - -### Running your changes - -To run Task with working changes, you can use `go run ./cmd/task`. To run a development build of task against a test Taskfile in `testdata`, you can use `go run ./cmd/task --dir ./testdata/ `. - -To run Task for Visual Studio Code, you can open the project in VSCode and hit F5 (or whatever you debug keybind is set to). This will open a new VSCode window with the extension running. Debugging this way is recommended as it will allow you to set breakpoints and step through the code. Otherwise, you can run `task package` which will generate a `.vsix` file that can be used to manually install the extension. - -### Updating documentation - -Task uses [Docusaurus][docusaurus] to host a documentation server. The code for this is located in the core Task repository. This can be setup and run locally by using `task docs` (requires `nodejs` & `yarn`). All content is written in Markdown and is located in the `docs/docs` directory. All Markdown documents should have an 80 character line wrap limit (enforced by Prettier). - -When making a change, consider whether a change to the [Usage Guide](/usage) is necessary. This document contains descriptions and examples of how to use Task features. If you're adding a new feature, try to find an appropriate place to add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](/styleguide). - -If you added a new field, command or flag, ensure that you add it to the [API Reference](/api). New fields also need to be added to the [JSON Schema][json-schema]. The descriptions for fields in the API reference and the schema should match. - -### Writing tests - -A lot of Task's tests are held in the `task_test.go` file in the project root and this is where you'll most likely want to add new ones too. Most of these tests also have a subdirectory in the `testdata` directory where any Taskfiles/data required to run the tests are stored. - -When making a changes, consider whether new tests are required. These tests should ensure that the functionality you are adding will continue to work in the future. Existing tests may also need updating if you have changed Task's behavior. - -You may also consider adding unit tests for any new functions you have added. The unit tests should follow the Go convention of being location in a file named `*_test.go` in the same package as the code being tested. - -## 3. Committing your code - -Try to write meaningful commit messages and avoid having too many commits on the PR. Most PRs should likely have a single commit (although for bigger PRs it may be reasonable to split it in a few). Git squash and rebase is your friend! - -If you're not sure how to format your commit message, check out [Conventional Commits][conventional-commits]. This style is not enforced, but it is a good way to make your commit messages more readable and consistent. - -## 4. Submitting a PR - -- **Describe your changes** - Ensure that you provide a comprehensive description of your changes. -- **Issue/PR links** - Link any previous work such as related issues or PRs. Please describe how your changes differ to/extend this work. -- **Examples** - Add any examples or screenshots that you think are useful to demonstrate the effect of your changes. -- **Draft PRs** - If your changes are incomplete, but you would like to discuss them, open the PR as a draft and add a comment to start a discussion. Using comments rather than the PR description allows the description to be updated later while preserving any discussions. - -## FAQ - -> I want to contribute, where do I start? - -Take a look at the list of [open issues for Task][task-open-issues] or [Task for Visual Studio Code][vscode-task-open-issues]. We have a [good first issue][good-first-issue] label for simpler issues that are ideal for first time contributions. - -All kinds of contributions are welcome, whether its a typo fix or a shiny new feature. You can also contribute by upvoting/commenting on issues, helping to answer questions or contributing to other [community projects](/community). - -> I'm stuck, where can I get help? - -If you have questions, feel free to ask them in the `#help` forum channel on our [Discord server][discord-server] or open a [Discussion][discussion] on GitHub. - ---- - - - - -[task]: https://github.com/go-task/task -[vscode-task]: https://github.com/go-task/vscode-task -[go]: https://go.dev -[gofumpt]: https://github.com/mvdan/gofumpt -[golangci-lint]: https://golangci-lint.run -[prettier]: https://prettier.io -[nodejs]: https://nodejs.org/en/ -[yarn]: https://yarnpkg.com/ -[docusaurus]: https://docusaurus.io -[json-schema]: https://github.com/go-task/task/blob/main/docs/static/schema.json -[task-open-issues]: https://github.com/go-task/task/issues -[vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues -[good-first-issue]: https://github.com/go-task/task/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 -[discord-server]: https://discord.gg/6TY36E39UK -[discussion]: https://github.com/go-task/task/discussions -[conventional-commits]: https://www.conventionalcommits.org diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/deprecations/deprecations.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/deprecations/deprecations.md deleted file mode 100644 index 965b26d1..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/deprecations/deprecations.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: /deprecations/ -sidebar_position: 7 ---- - -# Deprecations - -As Task evolves, it occasionally outgrows some of its functionality. This can be because they are no longer useful, because another feature has replaced it or because of a change in the way that Task works internally. - -When this happens, we mark the functionality as deprecated. This means that it will be removed in a future version of Task. This functionality will continue to work until that time, but we strongly recommend that you do not implement this functionality in new Taskfiles and make a plan to migrate away from it as soon as possible. - -You can view a full list of active deprecations in the "Deprecations" section of the sidebar. diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/deprecations/template.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/deprecations/template.md deleted file mode 100644 index 646e45c6..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/deprecations/template.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Deprecated Feature\} (#\{Issue\}) - -:::warning - -This deprecation breaks the following functionality: - -- \{list any existing functionality that will be broken by this deprecation\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -\{Short description of the feature/behavior and why it is being deprecated\} - -\{Short explanation of any replacement features/behaviors and how users should migrate to it\} diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md deleted file mode 100644 index c45fb65d..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -slug: /deprecations/version-2-schema/ ---- - -# Version 2 Schema (#1197) - -:::warning - -This deprecation breaks the following functionality: - -- Any Taskfiles that use the version 2 schema -- `Taskvar.yml` files - -::: - -The Taskfile version 2 schema was introduced in March 2018 and replaced by version 3 in August 2019. In May 2023 [we published a deprecation notice][deprecation-notice] for the version 2 schema on the basis that the vast majority of users had already upgraded to version 3 and removing support for version 2 would allow us to tidy up the codebase and focus on new functionality instead. - -In December 2023, the final version of Task that supports the version 2 schema ([v3.33.0][v3.33.0]) was published and all legacy code was removed from Task's main branch. To use a more recent version of Task, you will need to ensure that your Taskfile uses the version 3 schema instead. A list of changes between version 2 and version 3 are available in the [Task v3 Release Notes][v3.0.0]. - - - - -[v3.0.0]: https://github.com/go-task/task/releases/tag/v3.0.0 -[v3.33.0]: https://github.com/go-task/task/releases/tag/v3.33.0 -[deprecation-notice]: https://github.com/go-task/task/issues/1197 diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/donate.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/donate.md deleted file mode 100644 index ccc07c7a..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/donate.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: /donate/ -sidebar_position: 16 ---- - -# Bağış Yapma - -If you find this project useful, you can consider donating by using one of the channels listed below. - -This is just a way of saying "thank you", it won't give you any benefits like higher priority on issues or something similar. - -Companies who donate at least $50/month will be featured as a "Gold Sponsor" in the website homepage and on the GitHub repository README. Make contact with [@andreynering][] with the logo you want to be shown. Suspect businesses (gambling, casinos, etc) won't be allowed, though. - -## GitHub Sponsorları - -The preferred way to donate to the maintainers is via GitHub Sponsors. Just use the following links to do your donation. We suggest a 50/50 split to each maintainer of the total amount you plan to donate to the project. - -- [@andreynering](https://github.com/sponsors/andreynering) -- [@pd93](https://github.com/sponsors/pd93) - -## Open Collective - -[OpenCollective](https://opencollective.com/task)'i tercih ediyorsan aşağıdaki bağlantıları kullanarak bağış yapabilirsin: - -- [Aylık $2](https://opencollective.com/task/contribute/backer-4034/checkout) -- [Aylık $5](https://opencollective.com/task/contribute/supporter-8404/checkout) -- [Aylık $20](https://opencollective.com/task/contribute/sponsor-4035/checkout) -- [Aylık $50](https://opencollective.com/task/contribute/sponsor-28775/checkout) -- [Özel değer - Tek seferlik bağış yapma desteklenir](https://opencollective.com/task/donate) - -## PayPal - -[@andreynering][]'e PayPal ile de bağış yapabilirsin: - -- [Herhangi bir değer - Tek seferlik bağış](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GSVDU63RKG45A¤cy_code=USD&source=url) - -## PIX (Sadece Brazilya) - -Ve eğer Brazilyalıysan, [bu QR Kodu](/img/pix.png) kullanarak [@andreynering][]'e PIX ile bağış yapabilirsin. - - - - -[@andreynering]: https://github.com/andreynering diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/any_variables.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/any_variables.md deleted file mode 100644 index cf2521c7..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/any_variables.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables (#1415) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any -time_. We strongly recommend that you do not use these features in a production -environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- Dynamically defined variables (using the `sh` keyword) - -::: - -:::info - -To enable this experiment, set the environment variable: -`TASK_X_ANY_VARIABLES=1`. Check out [our guide to enabling experiments -][enabling-experiments] for more information. - -::: - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the [slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for "collection-type" variables, the `for` -keyword has been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -This also works for maps. When looping over a map we also make an additional -`{{.KEY}}` variable availabe that holds the string value of the map key. -Remember that maps are unordered, so the order in which the items are looped -over is random: - -```yaml -version: 3 - -tasks: - foo: - vars: - MAP: - KEY_1: - SUBKEY: sub_value_1 - KEY_2: - SUBKEY: sub_value_2 - KEY_3: - SUBKEY: sub_value_3 - cmds: - - for: - var: MAP - cmd: echo {{.KEY}} {{.ITEM.SUBKEY}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[enabling-experiments]: /experiments/#enabling-experiments - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx deleted file mode 100644 index 73cdcd80..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables - -- Issue: #1415 -- Environment variable: `TASK_X_ANY_VARIABLES=1` -- Breaks: - - Dynamically defined variables (using the `sh` keyword) - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the -[slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for array variables, the `for` keyword has -been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/experiments.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/experiments.md deleted file mode 100644 index 6b9cd6e0..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/experiments.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -slug: /experiments/ -sidebar_position: 6 ---- - -# Deneyler - -:::caution - -Tüm deneysel özellikler, _herhangi bir zamanda_ önemli değişikliklere ve/veya kaldırmaya tabidir. Bu özellikleri bir üretim ortamında kullanmamanızı kesinlikle öneririz. Yanlızca test ve geri bildirim amaçlıdır. - -::: - -Task'ın hızlı bir şekilde gelişmesine izin vermek için, deneysel bayrakların arkasındaki küçük sürümlerde büyük değişiklikler yapıyoruz. Bu, büyük bir sürüm yayınlanmadan önce son değişiklikler hakkında geri bildirim toplamamızı sağlar. This document describes the current set of experimental features and their status in the [workflow](#workflow). - -You can view a full list of active experiments in the "Experiments" section of the sidebar. - -## Enabling Experiments - -You can enable an experimental feature by doing one of the following: - -1. İlgili ortam değişkenini bir görev komutunun önünde kullanma. Örneğin, `TASK_X_{FEATURE}=1 task {my-task}`. Bu, Task'ın deneysel özellikleri test etmek için tek seferlik çağrıları için tasarlanmıştır. -1. Using the relevant environment variable in your "dotfiles" (e.g. `.bashrc`, `.zshrc` etc.). This is intended for permanently enabling experimental features in your environment. -1. Creating a `.env` file in the same directory as your root Taskfile that contains the relevant environment variables. This allows you to enable an experimental feature at a project level. For example: - -```shell title=".env" -TASK_X_FEATURE=1 -``` - -## Current Experimental Features and Deprecations - -Each section below details an experiment or deprecation and explains what the flags/environment variables to enable the experiment are and how the feature's behavior will change. It will also explain what you need to do to migrate any existing Taskfiles to the new behavior. - -## Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -### 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -### 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -### 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -### 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -### 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -### Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/gentle_force.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/gentle_force.md deleted file mode 100644 index 514602bb..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/gentle_force.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -slug: /experiments/gentle-force/ ---- - -# Gentle Force (#1200) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- The `--force` flag - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_FORCE=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -The `--force` flag currently forces _all_ tasks to run regardless of the status checks. This can be useful, but we have found that most of the time users only expect the direct task they are calling to be forced and _not_ all of its dependant tasks. - -This experiment changes the `--force` flag to only force the directly called task. All dependant tasks will have their statuses checked as normal and will only run if Task considers them to be out of date. A new `--force-all` flag will also be added to maintain the current behavior for users that need this functionality. - -If you want to migrate, but continue to force all dependant tasks to run, you should replace all uses of the `--force` flag with `--force-all`. Alternatively, if you want to adopt the new behavior, you can continue to use the `--force` flag as you do now! - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md deleted file mode 100644 index 73a934d8..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -slug: /experiments/remote-taskfiles/ ---- - -# Remote Taskfiles (#1317) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_REMOTE_TASKFILES=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -This experiment allows you to specify a remote Taskfile URL when including a Taskfile. For example: - -```yaml -version: '3' - -includes: - my-remote-namespace: https://raw.githubusercontent.com/my-org/my-repo/main/Taskfile.yml -``` - -This works exactly the same way that including a local file does. Any tasks in the remote Taskfile will be available to run from your main Taskfile via the namespace `my-remote-namespace`. For example, if the remote file contains the following: - -```yaml -version: '3' - -tasks: - hello: - silent: true - cmds: - - echo "Hello from the remote Taskfile!" -``` - -and you run `task my-remote-namespace:hello`, it will print the text: "Hello from the remote Taskfile!" to your console. - -## Security - -Running commands from sources that you do not control is always a potential security risk. For this reason, we have added some checks when using remote Taskfiles: - -1. When running a task from a remote Taskfile for the first time, Task will print a warning to the console asking you to check that you are sure that you trust the source of the Taskfile. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the remote Taskfile will run and further calls to the remote Taskfile will not prompt you again. -2. Whenever you run a remote Taskfile, Task will create and store a checksum of the file that you are running. If the checksum changes, then Task will print another warning to the console to inform you that the contents of the remote file has changed. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the checksum will be updated and the remote Taskfile will run. - -Sometimes you need to run Task in an environment that does not have an interactive terminal, so you are not able to accept a prompt. In these cases you are able to tell task to accept these prompts automatically by using the `--yes` flag. Before enabling this flag, you should: - -1. Be sure that you trust the source and contents of the remote Taskfile. -2. Consider using a pinned version of the remote Taskfile (e.g. A link containing a commit hash) to prevent Task from automatically accepting a prompt that says a remote Taskfile has changed. - -Task currently supports both `http` and `https` URLs. However, the `http` requests will not execute by default unless you run the task with the `--insecure` flag. This is to protect you from accidentally running a remote Taskfile that is hosted on and unencrypted connection. Sources that are not protected by TLS are vulnerable to [man-in-the-middle attacks][man-in-the-middle-attacks] and should be avoided unless you know what you are doing. - -## Caching & Running Offline - -Whenever you run a remote Taskfile, the latest copy will be downloaded from the internet and cached locally. If for whatever reason, you lose access to the internet, you will still be able to run your tasks by specifying the `--offline` flag. This will tell Task to use the latest cached version of the file instead of trying to download it. You are able to use the `--download` flag to update the cached version of the remote files without running any tasks. - -By default, Task will timeout requests to download remote files after 10 seconds and look for a cached copy instead. This timeout can be configured by setting the `--timeout` flag and specifying a duration. For example, `--timeout 5s` will set the timeout to 5 seconds. - - - - -[enabling-experiments]: /experiments/#enabling-experiments -[man-in-the-middle-attacks]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/template.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/template.md deleted file mode 100644 index 59246cf5..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/template.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Experiment\} (#\{Issue\}) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- \{list any existing functionality that will be broken by this experiment\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_{feature}=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -\{Short description of the feature\} - -\{Short explanation of how users should migrate to the new behavior\} - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/workflow.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/workflow.md deleted file mode 100644 index 62aff616..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/experiments/workflow.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /experiments/workflow/ ---- - -# Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -## 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -## 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -## 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -## 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -## 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -## Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/faq.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/faq.md deleted file mode 100644 index b6aa46f9..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/faq.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -slug: /faq/ -sidebar_position: 15 ---- - -# FAQ - -This page contains a list of frequently asked questions about Task. - -## Why won't my task update my shell environment? - -This is a limitation of how shells work. Task runs as a subprocess of your current shell, so it can't change the environment of the shell that started it. This limitation is shared by other task runners and build tools too. - -A common way to work around this is to create a task that will generate output that can be parsed by your shell. For example, to set an environment variable on your shell you can write a task like this: - -```yaml -my-shell-env: - cmds: - - echo "export FOO=foo" - - echo "export BAR=bar" -``` - -Now run `eval $(task my-shell-env)` and the variables `$FOO` and `$BAR` will be available in your shell. - -## I can't reuse my shell in a task's commands - -Task runs each command as a separate shell process, so something you do in one command won't effect any future commands. For example, this won't work: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - a=foo - - echo $a - # outputs "" -``` - -To work around this you can either use a multiline command: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - | - a=foo - echo $a - # outputs "foo" -``` - -Or for more complex multi-line commands it is recommended to move your code into a separate file and call that instead: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - ./foo-printer.bash -``` - -```bash -#!/bin/bash -a=foo -echo $a -``` - -## 'x' builtin command doesn't work on Windows - -The default shell on Windows (`cmd` and `powershell`) do not have commands like `rm` and `cp` available as builtins. This means that these commands won't work. If you want to make your Taskfile fully cross-platform, you'll need to work around this limitation using one of the following methods: - -- Use the `{{OS}}` function to run an OS-specific script. -- Use something like `{{if eq OS "windows"}}powershell {{end}}` to detect windows and run the command in Powershell directly. -- Use a shell on Windows that supports these commands as builtins, such as [Git Bash][git-bash] or [WSL][wsl]. - -We want to make improvements to this part of Task and the issues below track this work. Constructive comments and contributions are very welcome! - -- #197 -- [mvdan/sh#93](https://github.com/mvdan/sh/issues/93) -- [mvdan/sh#97](https://github.com/mvdan/sh/issues/97) - - - - -[git-bash]: https://gitforwindows.org/ -[wsl]: https://learn.microsoft.com/en-us/windows/wsl/install diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/installation.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/installation.md deleted file mode 100644 index b26cdfbd..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/installation.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -slug: /installation/ -sidebar_position: 2 ---- - -# Kurulum - -Task birçok kurulum yöntemi sunar. Aşağıdaki mevcut yöntemlere göz atın. - -## Paket Yöneticileri - -### Homebrew - -Eğer macOS veya Linux kullanıyorsanız ve [Homebrew][homebrew] yüklüyse, Task'ı yüklemek şunu çalıştırmak kadar basittir: - -```bash -brew install go-task/tap/go-task -``` - -The above Formula is [maintained by ourselves](https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb). - -Son zamanlarda, Task [resmi Homebrew deposunda](https://formulae.brew.sh/formula/go-task) da kullanıma sunuldu, bu nedenle tercih ederseniz bu seçeneğe de sahipsiniz: - -```bash -brew install go-task -``` - -### Tea - -Eğer macOS veya Linux kullanıyorsanız ve [tea][tea] yüklüyse, Task'ı yüklemek şunu çalıştırmak kadar basittir: - -```bash -tea task -``` - -veya tea'nin magic'ini etkinleştirdiyseniz: - -```bash -task -``` -Bu yükleme yöntemi topluluğa aittir. Task'ın yeni bir sürümünden sonra, tea'da kullanılabilir olana kadar biraz zaman ayırın. - -### Snap - -Task, [Snapcraft][snapcraft]'ta mevcuttur, ancak Linux'unuzun dağıtım, Snaps to Task için klasik sınırlandırmanın doğru çalışmasına izin vermelidir: - -```bash -sudo snap install task --classic -``` - -### Chocolatey - -Windows kullanıyorsanız ve [Chocolatey][choco] yüklüyse, Task'ı yüklemek şunu çalıştırmak kadar basittir: - -```bash -choco install go-task -``` - -Bu yükleme yöntemi topluluğa aittir. - -### Scoop - -Windows kullanıyorsanız ve [Scoop][scoop] yüklüyse, Task'ı yüklemek şunu çalıştırmak kadar basittir: - -```cmd -scoop install task -``` - -Bu yükleme yöntemi topluluğa aittir. Task'ın yeni bir sürümünden sonra, Scoop'ta kullanılabilir olana kadar biraz zaman ayırın. - -### AUR - -Arch Linux kullanıyorsanız `yay`, `pacaur` veya `yaourt` gibi favori paket yöneticinizi kullanarak Task'ı [AUR](https://aur.archlinux.org/packages/go-task-bin)'dan yükleyebilirsiniz: - -```cmd -yay -S go-task-bin -``` - -Alternatif olarak, şu adresten yüklenen [bu paket](https://aur.archlinux.org/packages/go-task) var: [sürümler sayfasından](https://github.com/go-task/task/releases) derlenmiş dosyayı indirmek yerine kaynak kodu: - -```cmd -yay -S go-task -``` - -Bu yükleme yöntemi topluluğa aittir. - -### Fedora - -Fedora kullanıyorsanız Task'ı `dnf` kullanarak [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/)'nın resmi deposundan yükleyebilirsiniz: - -```cmd -sudo dnf install go-task -``` - -Bu yükleme yöntemi topluluğa aittir. Task'ın yeni bir sürümünden sonra, [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/)'da kullanılabilir olana kadar biraz zaman ayırın. - -### Nix - -NixOS kullanıyorsanız veya Nix yüklüyse Task'ı [nixpkgs](https://github.com/NixOS/nixpkgs)'den yükleyebilirsiniz: - -```cmd -nix-env -iA nixpkgs.go-task -``` - -Bu yükleme yöntemi topluluğa aittir. Task'ın yeni bir sürümünden sonra, [nixpkgs](https://github.com/NixOS/nixpkgs)'te kullanılabilir olana kadar biraz zaman ayırın. - -### npm - -[Bu paketi](https://www.npmjs.com/package/@go-task/cli) yükleyerek Task'ı yüklemek için Node ve npm komutlarını da kullanabilirsiniz. - -```bash -npm install -g @go-task/cli -``` - -### Winget - -Windows kullanıyorsanız ve [winget](https://github.com/microsoft/winget-cli) paket yönetim aracını kurduysanız, [winget-pkgs](https://github.com/microsoft/winget-pkgs)'den Task'ı kurabilirsiniz. - -```bash -winget install Task.Task -``` - -## Derlenmiş Dosyayı Yükleyin - -### Derlenmiş Dosya - -Derlenmiş dosyayı [GitHub'daki sürümler sayfasından][releases] indirebilir ve `$PATH`'nize ekleyebilirsiniz. - -DEB ve RPM paketleri de mevcuttur. - -`task_checksums.txt` dosyası, her dosya için SHA-256 doğrulamalarını içerir. - -### Script'i Yükleyin - -Ayrıca CI gibi senaryolarda çok yararlı olan bir [yükleme script][installscript]'imiz var. Bu komut dosyasının kolayca oluşturulmasını sağladığı için [GoDownloader][godownloader]'a çok teşekkürler. - -Varsayılan olarak, çalışma dizinine göre `./bin` dizinine kurulur: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -``` - -Kurulum dizinini `-b` parametresiyle geçersiz kılmak mümkündür. Linux'ta, geçerli kullanıcı için `~/.local/bin` ve `~/bin ` yüklemek veya tüm kullanıcılar için yüklemek için `/usr/local/bin` yaygın seçeneklerdir: - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin -``` - -:::caution - -macOS ve Windows'ta `~/.local/bin` ve `~/bin` varsayılan olarak `$PATH`'e eklenmez. - -::: - -### GitHub Actions - -Task'ı GitHub Actions'a yüklemek istiyorsanız, Arduino ekibi tarafından bu [action](https://github.com/arduino/setup-task)'u kullanmayı deneyebilirsiniz: - -```yaml -- name: Install Task - uses: arduino/setup-task@v1 - with: - version: 3.x - repo-token: ${{ secrets.GITHUB_TOKEN }} -``` - -Bu yükleme yöntemi topluluğa aittir. - -## Kaynaktan Oluştur - -### Go Modülleri - -[Go][go]'nun desteklenen bir sürümünün düzgün şekilde yüklendiğinden ve ayarlandığından emin olun. Go'nun gerekli minimum sürümünü [go.mod](https://github.com/go-task/task/blob/main/go.mod#L3) dosyasında bulabilirsiniz. - -Aşağıdakileri çalıştırarak en son sürümü global olarak yükleyebilirsiniz: - -```bash -go install github.com/go-task/task/v3/cmd/task@latest -``` - -Veya başka bir dizine kurabilirsiniz: - -```bash -env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest -``` - -:::tip - -CI ortamları için bunun yerine, yalnızca en son yayınlanan derlenmiş dosyayı indireceğinden daha hızlı ve daha kararlı olan [yükleme script](#install-script)'ini kullanmanızı öneririz. - -::: - -## Tamamlamaları Kurma - -Shell'inize karşılık gelen otomatik tamamlama dosyasını indirin. - -[Tüm tamamlamalar, Task'ın deposunda mevcuttur](https://github.com/go-task/task/tree/main/completion). - -### Bash - -Öncelikle, paket yöneticinizi kullanarak bash-completion'ı kurduğunuzdan emin olun. - -Tamamlama dosyasını çalıştırılabilir yapın: - -``` -chmod +x path/to/task.bash -``` - -Ardından, bunu `~/.bash_profile` ekleyin: - -```shell -source path/to/task.bash -``` - -### ZSH - -`_task` dosyasını `$FPATH` içinde bir yere koyun: - -```shell -mv path/to/_task /usr/local/share/zsh/site-functions/_task -``` - -`~/.zshrc` dosyanızda aşağıdakilerin bulunduğundan emin olun: - -```shell -autoload -U compinit -compinit -i -``` - -ZSH'nin sürüm 5.7 veya üstü önerilir. - -### Fish - -`task.fish` tamamlama script'ini taşıyın: - -```shell -mv path/to/task.fish ~/.config/fish/completions/task.fish -``` - -### PowerShell - -Profil script'inizi aşağıdakilerle açın: - -``` -mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue -notepad $profile -``` - -Aşağıdaki satırı ekleyin ve dosyayı kaydedin: - -```shell -Invoke-Expression -Command path/to/task.ps1 -``` - - - - -[go]: https://golang.org/ -[snapcraft]: https://snapcraft.io/task -[homebrew]: https://brew.sh/ -[installscript]: https://github.com/go-task/task/blob/main/install-task.sh -[releases]: https://github.com/go-task/task/releases -[godownloader]: https://github.com/goreleaser/godownloader -[choco]: https://chocolatey.org/ -[scoop]: https://scoop.sh/ -[tea]: https://tea.xyz/ diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/integrations.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/integrations.md deleted file mode 100644 index b6e4c800..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/integrations.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -slug: /integrations/ -sidebar_position: 8 ---- - -# Integrations - -## Visual Studio Code Extension - -Task has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task). The code for this project can be found [here](https://github.com/go-task/vscode-task). To use this extension, you must have Task v3.23.0+ installed on your system. - -This extension provides the following features (and more): - -- View tasks in the sidebar. -- Run tasks from the sidebar and command palette. -- Go to definition from the sidebar and command palette. -- Run last task command. -- Multi-root workspace support. -- Initialize a Taskfile in the current workspace. - -To get autocompletion and validation for your Taskfile, see the [Schema](#schema) section below. - -![Task for Visual Studio Code](https://github.com/go-task/vscode-task/blob/main/res/preview.png?raw=true) - -## Schema - -This was initially created by @KROSF in [this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and is now officially maintained in [this file](https://github.com/go-task/task/blob/main/docs/static/schema.json) and made available at https://taskfile.dev/schema.json. This schema can be used to validate Taskfiles and provide autocompletion in many code editors: - -### Visual Studio Code - -To integrate the schema into VS Code, you need to install the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) by Red Hat. Any `Taskfile.yml` in your project should automatically be detected and validation/autocompletion should work. If this doesn't work or you want to manually configure it for files with a different name, you can add the following to your `settings.json`: - -```json -// settings.json -{ - "yaml.schemas": { - "https://taskfile.dev/schema.json": [ - "**/Taskfile.yml", - "./path/to/any/other/taskfile.yml" - ] - } -} -``` - -You can also configure the schema directly inside of a Taskfile by adding the following comment to the top of the file: - -```yaml -# yaml-language-server: $schema=https://taskfile.dev/schema.json -version: '3' -``` - -You can find more information on this in the [YAML language server project](https://github.com/redhat-developer/yaml-language-server). - -## Community Integrations - -In addition to our official integrations, there is an amazing community of developers who have created their own integrations for Task: - -- [Sublime Text Plugin](https://packagecontrol.io/packages/Taskfile) [[source](https://github.com/biozz/sublime-taskfile)] by @biozz -- [IntelliJ Plugin](https://plugins.jetbrains.com/plugin/17058-taskfile) [[source](https://github.com/lechuckroh/task-intellij-plugin)] by @lechuckroh -- [mk](https://github.com/pycontribs/mk) command line tool recognizes Taskfiles natively. - -If you have made something that integrates with Task, please feel free to open a PR to add it to this list. diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/intro.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/intro.md deleted file mode 100644 index c06c1cf3..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/intro.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -slug: / -sidebar_position: 1 -title: Home ---- - -# Task - -
- -
- -Task is a task runner / build tool that aims to be simpler and easier to use than, for example, [GNU Make][make]. - -Since it's written in [Go][go], Task is just a single binary and has no other dependencies, which means you don't need to mess with any complicated install setups just to use a build tool. - -Once [installed](/installation), you just need to describe your build tasks using a simple [YAML][yaml] schema in a file called `Taskfile.yml`: - -```yaml title="Taskfile.yml" -version: '3' - -tasks: - hello: - cmds: - - echo 'Hello World from Task!' - silent: true -``` - -And call it by running `task hello` from your terminal. - -The above example is just the start, you can take a look at the [usage](/usage) guide to check the full schema documentation and Task features. - -## Features - -- [Easy installation](/installation): just download a single binary, add to `$PATH` and you're done! Or you can also install using [Homebrew][homebrew], [Snapcraft][snapcraft], or [Scoop][scoop] if you want. -- Available on CIs: by adding [this simple command](/installation#install-script) to install on your CI script and you're ready to use Task as part of your CI pipeline; -- Truly cross-platform: while most build tools only work well on Linux or macOS, Task also supports Windows thanks to [this shell interpreter for Go][sh]. -- Great for code generation: you can easily [prevent a task from running](/usage#prevent-unnecessary-work) if a given set of files haven't changed since last run (based either on its timestamp or content). - - - - -[make]: https://www.gnu.org/software/make/ -[go]: https://go.dev/ -[yaml]: http://yaml.org/ -[homebrew]: https://brew.sh/ -[snapcraft]: https://snapcraft.io/ -[scoop]: https://scoop.sh/ -[sh]: https://github.com/mvdan/sh diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/releasing.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/releasing.md deleted file mode 100644 index b232b322..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/releasing.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /releasing/ -sidebar_position: 13 ---- - -# Releasing - -The release process of Task is done with the help of [GoReleaser][goreleaser]. You can test the release process locally by calling the `test-release` task of the Taskfile. - -[GitHub Actions](https://github.com/go-task/task/actions) should release artifacts automatically when a new Git tag is pushed to `main` branch (raw executables and DEB and RPM packages). - -Since v3.15.0, raw executables can also be reproduced and verified locally by checking out a specific tag and calling `goreleaser build`, using the Go version defined in the above GitHub Actions. - -# Homebrew - -Goreleaser will automatically push a new commit to the [Formula/go-task.rb][gotaskrb] file in the [Homebrew tap][homebrewtap] repository to release the new version. - -# npm - -To release to npm update the version in the [`package.json`][packagejson] file and then run `task npm:publish` to push it. - -# Snapcraft - -The [snap package][snappackage] requires to manual steps to release a new version: - -- Updating the current version on [snapcraft.yaml][snapcraftyaml]. -- Moving both `amd64`, `armhf` and `arm64` new artifacts to the stable channel on the [Snapcraft dashboard][snapcraftdashboard]. - -# winget - -winget also requires manual steps to be completed. By running `task goreleaser:test` locally, manifest files will be generated on `dist/winget/manifests/t/Task/Task/v{version}`. [Upload the manifest directory into this fork](https://github.com/go-task/winget-pkgs/tree/master/manifests/t/Task/Task) and open a pull request into [this repository](https://github.com/microsoft/winget-pkgs). - -# Scoop - -Scoop is a command-line package manager for the Windows operating system. Scoop package manifests are maintained by the community. Scoop owners usually take care of updating versions there by editing [this file](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json). If you think its Task version is outdated, open an issue to let us know. - -# Nix - -Nix is a community owned installation method. Nix package maintainers usually take care of updating versions there by editing [this file](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/development/tools/go-task/default.nix). If you think its Task version is outdated, open an issue to let us know. - - - - -[goreleaser]: https://goreleaser.com/ -[homebrewtap]: https://github.com/go-task/homebrew-tap -[gotaskrb]: https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb -[packagejson]: https://github.com/go-task/task/blob/main/package.json#L3 -[snappackage]: https://github.com/go-task/snap -[snapcraftyaml]: https://github.com/go-task/snap/blob/main/snap/snapcraft.yaml#L2 -[snapcraftdashboard]: https://snapcraft.io/task/releases diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/styleguide.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/styleguide.md deleted file mode 100644 index 753477a4..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/styleguide.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -slug: /styleguide/ -sidebar_position: 10 ---- - -# Styleguide - -This is the official Task styleguide for `Taskfile.yml` files. This guide contains some basic instructions to keep your Taskfile clean and familiar to other users. - -This contains general guidelines, but they don't necessarily need to be strictly followed. Feel free to disagree and proceed differently at some point if you need or want to. Also, feel free to open issues or pull requests with improvements to this guide. - -## Use the correct order of keywords - -- `version:` -- `includes:` -- Configuration ones, like `output:`, `silent:`, `method:` and `run:` -- `vars:` -- `env:`, `dotenv:` -- `tasks:` - -## Use 2 spaces for indentation - -This is the most common convention for YAML files, and Task follows it. - -```yaml -# bad -tasks: - foo: - cmds: - - echo 'foo' - - -# good -tasks: - foo: - cmds: - - echo 'foo' -``` - -## Separate with spaces the mains sections - -```yaml -# bad -version: '3' -includes: - docker: ./docker/Taskfile.yml -output: prefixed -vars: - FOO: bar -env: - BAR: baz -tasks: - # ... - - -# good -version: '3' - -includes: - docker: ./docker/Taskfile.yml - -output: prefixed - -vars: - FOO: bar - -env: - BAR: baz - -tasks: - # ... -``` - -## Add spaces between tasks - -```yaml -# bad -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - bar: - cmds: - - echo 'bar' - baz: - cmds: - - echo 'baz' - - -# good -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - - bar: - cmds: - - echo 'bar' - - baz: - cmds: - - echo 'baz' -``` - -## Use upper-case variable names - -```yaml -# bad -version: '3' - -vars: - binary_name: myapp - -tasks: - build: - cmds: - - go build -o {{.binary_name}} . - - -# good -version: '3' - -vars: - BINARY_NAME: myapp - -tasks: - build: - cmds: - - go build -o {{.BINARY_NAME}} . -``` - -## Don't wrap vars in spaces when templating - -```yaml -# bad -version: '3' - -tasks: - greet: - cmds: - - echo '{{ .MESSAGE }}' - - -# good -version: '3' - -tasks: - greet: - cmds: - - echo '{{.MESSAGE}}' -``` - -This convention is also used by most people for any Go templating. - -## Separate task name words with a dash - -```yaml -# bad -version: '3' - -tasks: - do_something_fancy: - cmds: - - echo 'Do something' - - -# good -version: '3' - -tasks: - do-something-fancy: - cmds: - - echo 'Do something' -``` - -## Use colon for task namespacing - -```yaml -# good -version: '3' - -tasks: - docker:build: - cmds: - - docker ... - - docker:run: - cmds: - - docker-compose ... -``` - -This is also done automatically when using included Taskfiles. - -## Prefer external scripts over complex multi-line commands - -```yaml -# bad -version: '3' - -tasks: - build: - cmds: - - | - for i in $(seq 1 10); do - echo $i - echo "some other complex logic" - done' - -# good -version: '3' - -tasks: - build: - cmds: - - ./scripts/my_complex_script.sh -``` diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/taskfile_versions.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/taskfile_versions.md deleted file mode 100644 index aaa1ab71..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/taskfile_versions.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -slug: /taskfile-versions/ -sidebar_position: 5 ---- - -# Taskfile Versions - -The Taskfile syntax and features changed with time. This document explains what changed on each version and how to upgrade your Taskfile. - -## What the Taskfile version mean - -The Taskfile version follows the Task version. E.g. the change to Taskfile version `2` means that Task `v2.0.0` should be release to support it. - -The `version:` key on Taskfile accepts a semver string, so either `2`, `2.0` or `2.0.0` is accepted. If you choose to use `2.0` Task will not enable future `2.1` features, but if you choose to use `2`, then any `2.x.x` features will be available, but not `3.0.0+`. - -## Version 3 ![latest](https://img.shields.io/badge/latest-brightgreen) - -These are some major changes done on `v3`: - -- Task's output will now be colored -- Added support for `.env` like files -- Added `label:` setting to task so one can override how the task name appear in the logs -- A global `method:` was added to allow setting the default method, and Task's default changed to `checksum` -- Two magic variables were added when using `status:`: `CHECKSUM` and `TIMESTAMP` which contains, respectively, the XXH3 checksum and greatest modification timestamp of the files listed on `sources:` -- Also, the `TASK` variable is always available with the current task name -- CLI variables are always treated as global variables -- Added `dir:` option to `includes` to allow choosing on which directory an included Taskfile will run: - -```yaml -includes: - docs: - taskfile: ./docs - dir: ./docs -``` - -- Implemented short task syntax. All below syntaxes are equivalent: - -```yaml -version: '3' - -tasks: - print: - cmds: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: echo "Hello, World!" -``` - -- There was a major refactor on how variables are handled. They're now easier to understand. The `expansions:` setting was removed as it became unnecessary. This is the order in which Task will process variables, each level can see the variables set by the previous one and override those. - - Environment variables - - Global + CLI variables - - Call variables - - Task variables - -## Version 2.6 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.6 comes with `preconditions` stanza in tasks. - -```yaml -version: '2' - -tasks: - upload_environment: - preconditions: - - test -f .env - cmds: - - aws s3 cp .env s3://myenvironment -``` - -Please check the [documentation][includes] - -## Version 2.2 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.2 comes with a global `includes` options to include other Taskfiles: - -```yaml -version: '2' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -## Version 2.1 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.1 includes a global `output` option, to allow having more control over how commands output are printed to the console (see [documentation][output] for more info): - -```yaml -version: '2' - -output: prefixed - -tasks: - server: - cmds: - - go run main.go - prefix: server -``` - -From this version it's also possible to ignore errors of a command or task (check documentation [here][ignore_errors]): - -```yaml -version: '2' - -tasks: - example-1: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "This will be print" - - example-2: - cmds: - - exit 1 - - echo "This will be print" - ignore_error: true -``` - -## Version 2.0 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -At version 2, we introduced the `version:` key, to allow us to evolve Task with new features without breaking existing Taskfiles. The new syntax is as follows: - -```yaml -version: '2' - -tasks: - echo: - cmds: - - echo "Hello, World!" -``` - -Version 2 allows you to write global variables directly in the Taskfile, if you don't want to create a `Taskvars.yml`: - -```yaml -version: '2' - -vars: - GREETING: Hello, World! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -The variable priority order changed to the following: - -1. Task variables -2. Call variables -3. Taskfile variables -4. Taskvars file variables -5. Environment variables - -A new global option was added to configure the number of variables expansions (which default to 2): - -```yaml -version: '2' - -expansions: 3 - -vars: - FOO: foo - BAR: bar - BAZ: baz - FOOBAR: '{{.FOO}}{{.BAR}}' - FOOBARBAZ: '{{.FOOBAR}}{{.BAZ}}' - -tasks: - default: - cmds: - - echo "{{.FOOBARBAZ}}" -``` - -## Version 1 - -:::caution - -v1 schema support was removed in Task >= v3.0.0. - -::: - -In the first version of the `Taskfile`, the `version:` key was not available, because the tasks was in the root of the YAML document. Like this: - -```yaml -echo: - cmds: - - echo "Hello, World!" -``` - -The variable priority order was also different: - -1. Call variables -2. Environment -3. Task variables -4. `Taskvars.yml` variables - - - - -[deprecate-version-2-schema]: /deprecations/version-2-schema/ -[output]: /usage#output-syntax -[ignore_errors]: /usage#ignore-errors -[includes]: /usage#including-other-taskfiles diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/translate.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/translate.md deleted file mode 100644 index 34cdd719..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/translate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -slug: /translate/ -sidebar_position: 12 ---- - -# Translate - -Want to help us translate this documentation? In this document we explain how. - -Do NOT edit translated markdown files directly on the GitHub repository! We use [Crowdin][crowdin] to allow contributors on work on translations. The repository is periodically updated with progress from Crowdin. - -If you want to have access to the Crowdin project to be able to suggest translations, please ask for access on the [#translations channel on our Discord server][discord]. If a given language is not being shown to Crowdin yet, just ask and we can configure it. - - - - -[crowdin]: https://crowdin.com/project/taskfile -[discord]: https://discord.gg/6TY36E39UK diff --git a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/usage.md b/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/usage.md deleted file mode 100644 index 348ca605..00000000 --- a/docs/i18n/tr-TR/docusaurus-plugin-content-docs/current/usage.md +++ /dev/null @@ -1,1624 +0,0 @@ ---- -slug: /usage/ -sidebar_position: 3 ---- - -# Kullanım - -## Başlangıç - -Projenizin kök dizininde `Taskfile.yml` isimli bir dosya oluşturun. `cmds` bir görevin komutlarını içermelidir. The example below allows compiling a Go app and uses [esbuild](https://esbuild.github.io/) to concat and minify multiple CSS files into a single one. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -Running the tasks is as simple as running: - -```bash -task assets build -``` - -Task uses [mvdan.cc/sh](https://mvdan.cc/sh/), a native Go sh interpreter. So you can write sh/bash commands, and it will work even on Windows, where `sh` or `bash` are usually not available. Just remember any executable called must be available by the OS or in PATH. - -If you omit a task name, "default" will be assumed. - -## Desteklenen dosya isimleri - -Task, öncelik sırasına göre aşağıdaki dosya isimlerine bakar: - -- Taskfile.yml -- taskfile.yml -- Taskfile.yaml -- taskfile.yaml -- Taskfile.dist.yml -- taskfile.dist.yml -- Taskfile.dist.yaml -- taskfile.dist.yaml - -The intention of having the `.dist` variants is to allow projects to have one committed version (`.dist`) while still allowing individual users to override the Taskfile by adding an additional `Taskfile.yml` (which would be on `.gitignore`). - -### Taskfile'ı alt-dizinden çalıştırma - -If a Taskfile cannot be found in the current working directory, it will walk up the file tree until it finds one (similar to how `git` works). When running Task from a subdirectory like this, it will behave as if you ran it from the directory containing the Taskfile. - -You can use this functionality along with the special `{{.USER_WORKING_DIR}}` variable to create some very useful reusable tasks. For example, if you have a monorepo with directories for each microservice, you can `cd` into a microservice directory and run a task command to bring it up without having to create multiple tasks or Taskfiles with identical content. For example: - -```yaml -version: '3' - -tasks: - up: - dir: '{{.USER_WORKING_DIR}}' - preconditions: - - test -f docker-compose.yml - cmds: - - docker-compose up -d -``` - -In this example, we can run `cd ` and `task up` and as long as the `` directory contains a `docker-compose.yml`, the Docker composition will be brought up. - -### Bir küresel Taskfile çalıştırma - -If you call Task with the `--global` (alias `-g`) flag, it will look for your home directory instead of your working directory. In short, Task will look for a Taskfile that matches `$HOME/{T,t}askfile.{yml,yaml}` . - -This is useful to have automation that you can run from anywhere in your system! - -:::info - -When running your global Taskfile with `-g`, tasks will run on `$HOME` by default, and not on your working directory! - -As mentioned in the previous section, the `{{.USER_WORKING_DIR}}` special variable can be very handy here to run stuff on the directory you're calling `task -g` from. - -```yaml -version: '3' - -tasks: - from-home: - cmds: - - pwd - - from-working-directory: - dir: '{{.USER_WORKING_DIR}}' - cmds: - - pwd -``` - -::: - -## Ortam değişkenleri - -### Task - -You can use `env` to set custom environment variables for a specific task: - -```yaml -version: '3' - -tasks: - greet: - cmds: - - echo $GREETING - env: - GREETING: Hey, there! -``` - -Additionally, you can set global environment variables that will be available to all tasks: - -```yaml -version: '3' - -env: - GREETING: Hey, there! - -tasks: - greet: - cmds: - - echo $GREETING -``` - -:::info - -`env` supports expansion and retrieving output from a shell command just like variables, as you can see in the [Variables](#variables) section. - -::: - -### .env files - -You can also ask Task to include `.env` like files by using the `dotenv:` setting: - -```bash title=".env" -KEYNAME=VALUE -``` - -```bash title="testing/.env" -ENDPOINT=testing.com -``` - -```yaml title="Taskfile.yml" -version: '3' - -env: - ENV: testing - -dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - -tasks: - greet: - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Dotenv files can also be specified at the task level: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -Environment variables specified explicitly at the task-level will override variables defined in dotfiles: - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - env: - KEYNAME: DIFFERENT_VALUE - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -:::info - -Please note that you are not currently able to use the `dotenv` key inside included Taskfiles. - -::: - -## Including other Taskfiles - -If you want to share tasks between different projects (Taskfiles), you can use the importing mechanism to include other Taskfiles using the `includes` keyword: - -```yaml -version: '3' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -The tasks described in the given Taskfiles will be available with the informed namespace. So, you'd call `task docs:serve` to run the `serve` task from `documentation/Taskfile.yml` or `task docker:build` to run the `build` task from the `DockerTasks.yml` file. - -Relative paths are resolved relative to the directory containing the including Taskfile. - -### OS-specific Taskfiles - -With `version: '2'`, task automatically includes any `Taskfile_{{OS}}.yml` if it exists (for example: `Taskfile_windows.yml`, `Taskfile_linux.yml` or `Taskfile_darwin.yml`). Since this behavior was a bit too implicit, it was removed on version 3, but you still can have a similar behavior by explicitly importing these files: - -```yaml -version: '3' - -includes: - build: ./Taskfile_{{OS}}.yml -``` - -### Directory of included Taskfile - -By default, included Taskfile's tasks are run in the current directory, even if the Taskfile is in another directory, but you can force its tasks to run in another directory by using this alternative syntax: - -```yaml -version: '3' - -includes: - docs: - taskfile: ./docs/Taskfile.yml - dir: ./docs -``` - -:::info - -The included Taskfiles must be using the same schema version as the main Taskfile uses. - -::: - -### Optional includes - -Includes marked as optional will allow Task to continue execution as normal if the included file is missing. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./tests/Taskfile.yml - optional: true - -tasks: - greet: - cmds: - - echo "This command can still be successfully executed if - ./tests/Taskfile.yml does not exist" -``` - -### Internal includes - -Includes marked as internal will set all the tasks of the included file to be internal as well (see the [Internal tasks](#internal-tasks) section below). This is useful when including utility tasks that are not intended to be used directly by the user. - -```yaml -version: '3' - -includes: - tests: - taskfile: ./taskfiles/Utils.yml - internal: true -``` - -### Vars of included Taskfiles - -You can also specify variables when including a Taskfile. This may be useful for having reusable Taskfile that can be tweaked or even included more than once: - -```yaml -version: '3' - -includes: - backend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: backend_image - - frontend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: frontend_image -``` - -### Namespace aliases - -When including a Taskfile, you can give the namespace a list of `aliases`. This works in the same way as [task aliases](#task-aliases) and can be used together to create shorter and easier-to-type commands. - -```yaml -version: '3' - -includes: - generate: - taskfile: ./taskfiles/Generate.yml - aliases: [gen] -``` - -:::info - -Vars declared in the included Taskfile have preference over the variables in the including Taskfile! If you want a variable in an included Taskfile to be overridable, use the [default function](https://go-task.github.io/slim-sprig/defaults.html): `MY_VAR: '{{.MY_VAR | default "my-default-value"}}'`. - -::: - -## Internal tasks - -Internal tasks are tasks that cannot be called directly by the user. They will not appear in the output when running `task --list|--list-all`. Other tasks may call internal tasks in the usual way. This is useful for creating reusable, function-like tasks that have no useful purpose on the command line. - -```yaml -version: '3' - -tasks: - build-image-1: - cmds: - - task: build-image - vars: - DOCKER_IMAGE: image-1 - - build-image: - internal: true - cmds: - - docker build -t {{.DOCKER_IMAGE}} . -``` - -## Task directory - -By default, tasks will be executed in the directory where the Taskfile is located. But you can easily make the task run in another folder, informing `dir`: - -```yaml -version: '3' - -tasks: - serve: - dir: public/www - cmds: - # run http server - - caddy -``` - -If the directory does not exist, `task` creates it. - -## Task dependencies - -> Dependencies run in parallel, so dependencies of a task should not depend one another. If you want to force tasks to run serially, take a look at the [Calling Another Task](#calling-another-task) section below. - -You may have tasks that depend on others. Just pointing them on `deps` will make them run automatically before running the parent task: - -```yaml -version: '3' - -tasks: - build: - deps: [assets] - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -In the above example, `assets` will always run right before `build` if you run `task build`. - -A task can have only dependencies and no commands to group tasks together: - -```yaml -version: '3' - -tasks: - assets: - deps: [js, css] - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -If there is more than one dependency, they always run in parallel for better performance. - -:::tip - -You can also make the tasks given by the command line run in parallel by using the `--parallel` flag (alias `-p`). Example: `task --parallel js css`. - -::: - -If you want to pass information to dependencies, you can do that the same manner as you would to [call another task](#calling-another-task): - -```yaml -version: '3' - -tasks: - default: - deps: - - task: echo_sth - vars: { TEXT: 'before 1' } - - task: echo_sth - vars: { TEXT: 'before 2' } - silent: true - cmds: - - echo "after" - - echo_sth: - cmds: - - echo {{.TEXT}} -``` - -## Platform specific tasks and commands - -If you want to restrict the running of tasks to explicit platforms, this can be achieved using the `platforms:` key. Tasks can be restricted to a specific OS, architecture or a combination of both. On a mismatch, the task or command will be skipped, and no error will be thrown. - -The values allowed as OS or Arch are valid `GOOS` and `GOARCH` values, as defined by the Go language [here](https://github.com/golang/go/blob/master/src/go/build/syslist.go). - -The `build-windows` task below will run only on Windows, and on any architecture: - -```yaml -version: '3' - -tasks: - build-windows: - platforms: [windows] - cmds: - - echo 'Running command on Windows' -``` - -This can be restricted to a specific architecture as follows: - -```yaml -version: '3' - -tasks: - build-windows-amd64: - platforms: [windows/amd64] - cmds: - - echo 'Running command on Windows (amd64)' -``` - -It is also possible to restrict the task to specific architectures: - -```yaml -version: '3' - -tasks: - build-amd64: - platforms: [amd64] - cmds: - - echo 'Running command on amd64' -``` - -Multiple platforms can be specified as follows: - -```yaml -version: '3' - -tasks: - build: - platforms: [windows/amd64, darwin] - cmds: - - echo 'Running command on Windows (amd64) and macOS' -``` - -Individual commands can also be restricted to specific platforms: - -```yaml -version: '3' - -tasks: - build: - cmds: - - cmd: echo 'Running command on Windows (amd64) and macOS' - platforms: [windows/amd64, darwin] - - cmd: echo 'Running on all platforms' -``` - -## Calling another task - -When a task has many dependencies, they are executed concurrently. This will often result in a faster build pipeline. However, in some situations, you may need to call other tasks serially. In this case, use the following syntax: - -```yaml -version: '3' - -tasks: - main-task: - cmds: - - task: task-to-be-called - - task: another-task - - echo "Both done" - - task-to-be-called: - cmds: - - echo "Task to be called" - - another-task: - cmds: - - echo "Another task" -``` - -Using the `vars` and `silent` attributes you can choose to pass variables and toggle [silent mode](#silent-mode) on a call-by-call basis: - -```yaml -version: '3' - -tasks: - greet: - vars: - RECIPIENT: '{{default "World" .RECIPIENT}}' - cmds: - - echo "Hello, {{.RECIPIENT}}!" - - greet-pessimistically: - cmds: - - task: greet - vars: { RECIPIENT: 'Cruel World' } - silent: true -``` - -The above syntax is also supported in `deps`. - -:::tip - -NOTE: If you want to call a task declared in the root Taskfile from within an [included Taskfile](#including-other-taskfiles), add a leading `:` like this: `task: :task-name`. - -::: - -## Prevent unnecessary work - -### By fingerprinting locally generated files and their sources - -If a task generates something, you can inform Task the source and generated files, so Task will prevent running them if not necessary. - -```yaml -version: '3' - -tasks: - build: - deps: [js, css] - cmds: - - go build -v -i main.go - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - sources: - - src/js/**/*.js - generates: - - public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css - sources: - - src/css/**/*.css - generates: - - public/bundle.css -``` - -`sources` and `generates` can be files or glob patterns. When given, Task will compare the checksum of the source files to determine if it's necessary to run the task. If not, it will just print a message like `Task "js" is up to date`. - -`exclude:` can also be used to exclude files from fingerprinting. Sources are evaluated in order, so `exclude:` must come after the positive glob it is negating. - -```yaml -version: '3' - -tasks: - css: - sources: - - mysources/**/*.css - - exclude: mysources/ignoreme.css - generates: - - public/bundle.css -``` - -If you prefer these check to be made by the modification timestamp of the files, instead of its checksum (content), just set the `method` property to `timestamp`. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build . - sources: - - ./*.go - generates: - - app{{exeExt}} - method: timestamp -``` - -In situations where you need more flexibility the `status` keyword can be used. You can even combine the two. See the documentation for [status](#using-programmatic-checks-to-indicate-a-task-is-up-to-date) for an example. - -:::info - -By default, task stores checksums on a local `.task` directory in the project's directory. Most of the time, you'll want to have this directory on `.gitignore` (or equivalent) so it isn't committed. (If you have a task for code generation that is committed it may make sense to commit the checksum of that task as well, though). - -If you want these files to be stored in another directory, you can set a `TASK_TEMP_DIR` environment variable in your machine. It can contain a relative path like `tmp/task` that will be interpreted as relative to the project directory, or an absolute or home path like `/tmp/.task` or `~/.task` (subdirectories will be created for each project). - -```bash -export TASK_TEMP_DIR='~/.task' -``` - -::: - -:::info - -Each task has only one checksum stored for its `sources`. If you want to distinguish a task by any of its input variables, you can add those variables as part of the task's label, and it will be considered a different task. - -This is useful if you want to run a task once for each distinct set of inputs until the sources actually change. For example, if the sources depend on the value of a variable, or you if you want the task to rerun if some arguments change even if the source has not. - -::: - -:::tip - -The method `none` skips any validation and always run the task. - -::: - -:::info - -For the `checksum` (default) or `timestamp` method to work, it is only necessary to inform the source files. When the `timestamp` method is used, the last time of the running the task is considered as a generate. - -::: - -### Using programmatic checks to indicate a task is up to date - -Alternatively, you can inform a sequence of tests as `status`. If no error is returned (exit status 0), the task is considered up-to-date: - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - status: - - test -d directory - - test -f directory/file1.txt - - test -f directory/file2.txt -``` - -Normally, you would use `sources` in combination with `generates` - but for tasks that generate remote artifacts (Docker images, deploys, CD releases) the checksum source and timestamps require either access to the artifact or for an out-of-band refresh of the `.checksum` fingerprint file. - -Two special variables `{{.CHECKSUM}}` and `{{.TIMESTAMP}}` are available for interpolation within `status` commands, depending on the method assigned to fingerprint the sources. Only `source` globs are fingerprinted. - -Note that the `{{.TIMESTAMP}}` variable is a "live" Go `time.Time` struct, and can be formatted using any of the methods that `time.Time` responds to. - -See [the Go Time documentation](https://golang.org/pkg/time/) for more information. - -You can use `--force` or `-f` if you want to force a task to run even when up-to-date. - -Also, `task --status [tasks]...` will exit with a non-zero exit code if any of the tasks are not up-to-date. - -`status` can be combined with the [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) to have a task run if either the the source/generated artifacts changes, or the programmatic check fails: - -```yaml -version: '3' - -tasks: - build:prod: - desc: Build for production usage. - cmds: - - composer install - # Run this task if source files changes. - sources: - - composer.json - - composer.lock - generates: - - ./vendor/composer/installed.json - - ./vendor/autoload.php - # But also run the task if the last build was not a production build. - status: - - grep -q '"dev": false' ./vendor/composer/installed.json -``` - -### Using programmatic checks to cancel the execution of a task and its dependencies - -In addition to `status` checks, `preconditions` checks are the logical inverse of `status` checks. That is, if you need a certain set of conditions to be _true_ you can use the `preconditions` stanza. `preconditions` are similar to `status` lines, except they support `sh` expansion, and they SHOULD all return 0. - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - preconditions: - - test -f .env - - sh: '[ 1 = 0 ]' - msg: "One doesn't equal Zero, Halting" -``` - -Preconditions can set specific failure messages that can tell a user what steps to take using the `msg` field. - -If a task has a dependency on a sub-task with a precondition, and that precondition is not met - the calling task will fail. Note that a task executed with a failing precondition will not run unless `--force` is given. - -Unlike `status`, which will skip a task if it is up to date and continue executing tasks that depend on it, a `precondition` will fail a task, along with any other tasks that depend on it. - -```yaml -version: '3' - -tasks: - task-will-fail: - preconditions: - - sh: 'exit 1' - - task-will-also-fail: - deps: - - task-will-fail - - task-will-still-fail: - cmds: - - task: task-will-fail - - echo "I will not run" -``` - -### Limiting when tasks run - -If a task executed by multiple `cmds` or multiple `deps` you can control when it is executed using `run`. `run` can also be set at the root of the Taskfile to change the behavior of all the tasks unless explicitly overridden. - -Supported values for `run`: - -- `always` (default) always attempt to invoke the task regardless of the number of previous executions -- `once` only invoke this task once regardless of the number of references -- `when_changed` only invokes the task once for each unique set of variables passed into the task - -```yaml -version: '3' - -tasks: - default: - cmds: - - task: generate-file - vars: { CONTENT: '1' } - - task: generate-file - vars: { CONTENT: '2' } - - task: generate-file - vars: { CONTENT: '2' } - - generate-file: - run: when_changed - deps: - - install-deps - cmds: - - echo {{.CONTENT}} - - install-deps: - run: once - cmds: - - sleep 5 # long operation like installing packages -``` - -### Ensuring required variables are set - -If you want to check that certain variables are set before running a task then you can use `requires`. This is useful when might not be clear to users which variables are needed, or if you want clear message about what is required. Also some tasks could have dangerous side effects if run with un-set variables. - -Using `requires` you specify an array of strings in the `vars` sub-section under `requires`, these strings are variable names which are checked prior to running the task. If any variables are un-set the the task will error and not run. - -Environmental variables are also checked. - -Syntax: - -```yaml -requires: - vars: [] # Array of strings -``` - -:::note - -Variables set to empty zero length strings, will pass the `requires` check. - -::: - -Example of using `requires`: - -```yaml -version: '3' - -tasks: - docker-build: - cmds: - - 'docker build . -t {{.IMAGE_NAME}}:{{.IMAGE_TAG}}' - - # Make sure these variables are set before running - requires: - vars: [IMAGE_NAME, IMAGE_TAG] -``` - -## Variables - -When doing interpolation of variables, Task will look for the below. They are listed below in order of importance (i.e. most important first): - -- Variables declared in the task definition -- Variables given while calling a task from another (See [Calling another task](#calling-another-task) above) -- Variables of the [included Taskfile](#including-other-taskfiles) (when the task is included) -- Variables of the [inclusion of the Taskfile](#vars-of-included-taskfiles) (when the task is included) -- Global variables (those declared in the `vars:` option in the Taskfile) -- Environment variables - -Example of sending parameters with environment variables: - -```bash -$ TASK_VARIABLE=a-value task do-something -``` - -:::tip - -A special variable `.TASK` is always available containing the task name. - -::: - -Since some shells do not support the above syntax to set environment variables (Windows) tasks also accept a similar style when not at the beginning of the command. - -```bash -$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!" -``` - -Example of locally declared vars: - -```yaml -version: '3' - -tasks: - print-var: - cmds: - - echo "{{.VAR}}" - vars: - VAR: Hello! -``` - -Example of global vars in a `Taskfile.yml`: - -```yaml -version: '3' - -vars: - GREETING: Hello from Taskfile! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -### Dynamic variables - -The below syntax (`sh:` prop in a variable) is considered a dynamic variable. The value will be treated as a command and the output assigned. If there are one or more trailing newlines, the last newline will be trimmed. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go - vars: - GIT_COMMIT: - sh: git log -n 1 --format=%h -``` - -This works for all types of variables. - -## Looping over values - -As of v3.28.0, Task allows you to loop over certain values and execute a command for each. There are a number of ways to do this depending on the type of value you want to loop over. - -### Looping over a static list - -The simplest kind of loop is an explicit one. This is useful when you want to loop over a set of values that are known ahead of time. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: ['foo.txt', 'bar.txt'] - cmd: cat {{ .ITEM }} -``` - -### Looping over your task's sources - -You are also able to loop over the sources of your task: - -```yaml -version: '3' - -tasks: - default: - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{ .ITEM }} -``` - -This will also work if you use globbing syntax in your sources. For example, if you specify a source for `*.txt`, the loop will iterate over all files that match that glob. - -Source paths will always be returned as paths relative to the task directory. If you need to convert this to an absolute path, you can use the built-in `joinPath` function. There are some [special variables](/api/#special-variables) that you may find useful for this. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_DIR: /path/to/dir - dir: '{{.MY_DIR}}' - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{joinPath .MY_DIR .ITEM}} -``` - -### Looping over variables - -To loop over the contents of a variable, you simply need to specify the variable you want to loop over. By default, variables will be split on any whitespace characters. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -If you need to split on a different character, you can do this by specifying the `split` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt,bar.txt - cmds: - - for: { var: MY_VAR, split: ',' } - cmd: cat {{.ITEM}} -``` - -All of this also works with dynamic variables! - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: - sh: find -type f -name '*.txt' - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -### Renaming variables - -If you want to rename the iterator variable to make it clearer what the value contains, you can do so by specifying the `as` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR, as: FILE } - cmd: cat {{.FILE}} -``` - -### Looping over tasks - -Because the `for` property is defined at the `cmds` level, you can also use it alongside the `task` keyword to run tasks multiple times with different variables. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: my-task - vars: - FILE: '{{.ITEM}}' - - my-task: - cmds: - - echo '{{.FILE}}' -``` - -Or if you want to run different tasks depending on the value of the loop: - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: task-{{.ITEM}} - - task-foo: - cmds: - - echo 'foo' - - task-bar: - cmds: - - echo 'bar' -``` - -## Forwarding CLI arguments to commands - -If `--` is given in the CLI, all following parameters are added to a special `.CLI_ARGS` variable. This is useful to forward arguments to another command. - -The below example will run `yarn install`. - -```bash -$ task yarn -- install -``` - -```yaml -version: '3' - -tasks: - yarn: - cmds: - - yarn {{.CLI_ARGS}} -``` - -## Doing task cleanup with `defer` - -With the `defer` keyword, it's possible to schedule cleanup to be run once the task finishes. The difference with just putting it as the last command is that this command will run even when the task fails. - -In the example below, `rm -rf tmpdir/` will run even if the third command fails: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: rm -rf tmpdir/ - - echo 'Do work on tmpdir/' -``` - -If you want to move the cleanup command into another task, that is possible as well: - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: { task: cleanup } - - echo 'Do work on tmpdir/' - - cleanup: rm -rf tmpdir/ -``` - -:::info - -Due to the nature of how the [Go's own `defer` work](https://go.dev/tour/flowcontrol/13), the deferred commands are executed in the reverse order if you schedule multiple of them. - -::: - -## Go's template engine - -Task parse commands as [Go's template engine][gotemplate] before executing them. Variables are accessible through dot syntax (`.VARNAME`). - -All functions by the Go's [slim-sprig lib](https://go-task.github.io/slim-sprig/) are available. The following example gets the current date in a given format: - -```yaml -version: '3' - -tasks: - print-date: - cmds: - - echo {{now | date "2006-01-02"}} -``` - -Task also adds the following functions: - -- `OS`: Returns the operating system. Possible values are `windows`, `linux`, `darwin` (macOS) and `freebsd`. -- `ARCH`: return the architecture Task was compiled to: `386`, `amd64`, `arm` or `s390x`. -- `splitLines`: Splits Unix (`\n`) and Windows (`\r\n`) styled newlines. -- `catLines`: Replaces Unix (`\n`) and Windows (`\r\n`) styled newlines with a space. -- `toSlash`: Does nothing on Unix, but on Windows converts a string from `\` path format to `/`. -- `fromSlash`: Opposite of `toSlash`. Does nothing on Unix, but on Windows converts a string from `/` path format to `\`. -- `exeExt`: Returns the right executable extension for the current OS (`".exe"` for Windows, `""` for others). -- `shellQuote`: Quotes a string to make it safe for use in shell scripts. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote) for this. The Bash dialect is assumed. -- `splitArgs`: Splits a string as if it were a command's arguments. Task uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/shell#Fields) - -Example: - -```yaml -version: '3' - -tasks: - print-os: - cmds: - - echo '{{OS}} {{ARCH}}' - - echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}' - # This will be path/to/file on Unix but path\to\file on Windows - - echo '{{fromSlash "path/to/file"}}' - enumerated-file: - vars: - CONTENT: | - foo - bar - cmds: - - | - cat << EOF > output.txt - {{range $i, $line := .CONTENT | splitLines -}} - {{printf "%3d" $i}}: {{$line}} - {{end}}EOF -``` - -## Help - -Running `task --list` (or `task -l`) lists all tasks with a description. The following Taskfile: - -```yaml -version: '3' - -tasks: - build: - desc: Build the go binary. - cmds: - - go build -v -i main.go - - test: - desc: Run all the go tests. - cmds: - - go test -race ./... - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -would print the following output: - -```bash -* build: Build the go binary. -* test: Run all the go tests. -``` - -If you want to see all tasks, there's a `--list-all` (alias `-a`) flag as well. - -## Display summary of task - -Running `task --summary task-name` will show a summary of a task. The following Taskfile: - -```yaml -version: '3' - -tasks: - release: - deps: [build] - summary: | - Release your project to github - - It will build your project before starting the release. - Please make sure that you have set GITHUB_TOKEN before starting. - cmds: - - your-release-tool - - build: - cmds: - - your-build-tool -``` - -with running `task --summary release` would print the following output: - -``` -task: release - -Release your project to github - -It will build your project before starting the release. -Please make sure that you have set GITHUB_TOKEN before starting. - -dependencies: - - build - -commands: - - your-release-tool -``` - -If a summary is missing, the description will be printed. If the task does not have a summary or a description, a warning is printed. - -Please note: _showing the summary will not execute the command_. - -## Task aliases - -Aliases are alternative names for tasks. They can be used to make it easier and quicker to run tasks with long or hard-to-type names. You can use them on the command line, when [calling sub-tasks](#calling-another-task) in your Taskfile and when [including tasks](#including-other-taskfiles) with aliases from another Taskfile. They can also be used together with [namespace aliases](#namespace-aliases). - -```yaml -version: '3' - -tasks: - generate: - aliases: [gen] - cmds: - - task: gen-mocks - - generate-mocks: - aliases: [gen-mocks] - cmds: - - echo "generating..." -``` - -## Overriding task name - -Sometimes you may want to override the task name printed on the summary, up-to-date messages to STDOUT, etc. In this case, you can just set `label:`, which can also be interpolated with variables: - -```yaml -version: '3' - -tasks: - default: - - task: print - vars: - MESSAGE: hello - - task: print - vars: - MESSAGE: world - - print: - label: 'print-{{.MESSAGE}}' - cmds: - - echo "{{.MESSAGE}}" -``` - -## Warning Prompts - -Warning Prompts are used to prompt a user for confirmation before a task is executed. - -Below is an example using `prompt` with a dangerous command, that is called between two safe commands: - -```yaml -version: '3' - -tasks: - example: - cmds: - - task: not-dangerous - - task: dangerous - - task: another-not-dangerous - - not-dangerous: - cmds: - - echo 'not dangerous command' - - another-not-dangerous: - cmds: - - echo 'another not dangerous command' - - dangerous: - prompt: This is a dangerous command... Do you want to continue? - cmds: - - echo 'dangerous command' -``` - -```bash -❯ task dangerous -task: "This is a dangerous command... Do you want to continue?" [y/N] -``` - -Warning prompts are called before executing a task. If a prompt is denied Task will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue as normal. - -```bash -❯ task example -not dangerous command -task: "This is a dangerous command. Do you want to continue?" [y/N] -y -dangerous command -another not dangerous command -``` - -To skip warning prompts automatically, you can use the `--yes` (alias `-y`) option when calling the task. By including this option, all warnings, will be automatically confirmed, and no prompts will be shown. - -:::caution - -Tasks with prompts always fail by default on non-terminal environments, like a CI, where an `stdin` won't be available for the user to answer. In those cases, use `--yes` (`-y`) to force all tasks with a prompt to run. - -::: - -## Silent mode - -Silent mode disables the echoing of commands before Task runs it. For the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" -``` - -Normally this will be printed: - -```sh -echo "Print something" -Print something -``` - -With silent mode on, the below will be printed instead: - -```sh -Print something -``` - -There are four ways to enable silent mode: - -- At command level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: echo "Print something" - silent: true -``` - -- At task level: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" - silent: true -``` - -- Globally at Taskfile level: - -```yaml -version: '3' - -silent: true - -tasks: - echo: - cmds: - - echo "Print something" -``` - -- Or globally with `--silent` or `-s` flag - -If you want to suppress STDOUT instead, just redirect a command to `/dev/null`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "This will print nothing" > /dev/null -``` - -## Dry run mode - -Dry run mode (`--dry`) compiles and steps through each task, printing the commands that would be run without executing them. This is useful for debugging your Taskfiles. - -## Ignore errors - -You have the option to ignore errors during command execution. Given the following Taskfile: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - exit 1 - - echo "Hello World" -``` - -Task will abort the execution after running `exit 1` because the status code `1` stands for `EXIT_FAILURE`. However, it is possible to continue with execution using `ignore_error`: - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "Hello World" -``` - -`ignore_error` can also be set for a task, which means errors will be suppressed for all commands. Nevertheless, keep in mind that this option will not propagate to other tasks called either by `deps` or `cmds`! - -## Output syntax - -By default, Task just redirects the STDOUT and STDERR of the running commands to the shell in real-time. This is good for having live feedback for logging printed by commands, but the output can become messy if you have multiple commands running simultaneously and printing lots of stuff. - -To make this more customizable, there are currently three different output options you can choose: - -- `interleaved` (default) -- `group` -- `prefixed` - -To choose another one, just set it to root in the Taskfile: - -```yaml -version: '3' - -output: 'group' - -tasks: - # ... -``` - -The `group` output will print the entire output of a command once after it finishes, so you will not have live feedback for commands that take a long time to run. - -When using the `group` output, you can optionally provide a templated message to print at the start and end of the group. This can be useful for instructing CI systems to group all of the output for a given task, such as with [GitHub Actions' `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) or [Azure Pipelines](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?expand=1&view=azure-devops&tabs=bash#formatting-commands). - -```yaml -version: '3' - -output: - group: - begin: '::group::{{.TASK}}' - end: '::endgroup::' - -tasks: - default: - cmds: - - echo 'Hello, World!' - silent: true -``` - -```bash -$ task default -::group::default -Hello, World! -::endgroup:: -``` - -When using the `group` output, you may swallow the output of the executed command on standard output and standard error if it does not fail (zero exit code). - -```yaml -version: '3' - -silent: true - -output: - group: - error_only: true - -tasks: - passes: echo 'output-of-passes' - errors: echo 'output-of-errors' && exit 1 -``` - -```bash -$ task passes -$ task errors -output-of-errors -task: Failed to run task "errors": exit status 1 -``` - -The `prefix` output will prefix every line printed by a command with `[task-name]` as the prefix, but you can customize the prefix for a command with the `prefix:` attribute: - -```yaml -version: '3' - -output: prefixed - -tasks: - default: - deps: - - task: print - vars: { TEXT: foo } - - task: print - vars: { TEXT: bar } - - task: print - vars: { TEXT: baz } - - print: - cmds: - - echo "{{.TEXT}}" - prefix: 'print-{{.TEXT}}' - silent: true -``` - -```bash -$ task default -[print-foo] foo -[print-bar] bar -[print-baz] baz -``` - -:::tip - -The `output` option can also be specified by the `--output` or `-o` flags. - -::: - -## Interactive CLI application - -When running interactive CLI applications inside Task they can sometimes behave weirdly, especially when the [output mode](#output-syntax) is set to something other than `interleaved` (the default), or when interactive apps are run in parallel with other tasks. - -The `interactive: true` tells Task this is an interactive application and Task will try to optimize for it: - -```yaml -version: '3' - -tasks: - default: - cmds: - - vim my-file.txt - interactive: true -``` - -If you still have problems running an interactive app through Task, please open an issue about it. - -## Short task syntax - -Starting on Task v3, you can now write tasks with a shorter syntax if they have the default settings (e.g. no custom `env:`, `vars:`, `desc:`, `silent:` , etc): - -```yaml -version: '3' - -tasks: - build: go build -v -o ./app{{exeExt}} . - - run: - - task: build - - ./app{{exeExt}} -h localhost -p 8080 -``` - -## `set` and `shopt` - -It's possible to specify options to the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins. This can be added at global, task or command level. - -```yaml -version: '3' - -set: [pipefail] -shopt: [globstar] - -tasks: - # `globstar` required for double star globs to work - default: echo **/*.go -``` - -:::info - -Keep in mind that not all options are available in the [shell interpreter library](https://github.com/mvdan/sh) that Task uses. - -::: - -## Watch tasks - -With the flags `--watch` or `-w` task will watch for file changes and run the task again. This requires the `sources` attribute to be given, so task knows which files to watch. - -The default watch interval is 5 seconds, but it's possible to change it by either setting `interval: '500ms'` in the root of the Taskfile passing it as an argument like `--interval=500ms`. - -Also, it's possible to set `watch: true` in a given task and it'll automatically run in watch mode: - -```yaml -version: '3' - -interval: 500ms - -tasks: - build: - desc: Builds the Go application - watch: true - sources: - - '**/*.go' - cmds: - - go build # ... -``` - -:::info - -Note that when setting `watch: true` to a task, it'll only run in watch mode when running from the CLI via `task my-watch-task`, but won't run in watch mode if called by another task, either directly or as a dependency. - -::: - - - - -[gotemplate]: https://golang.org/pkg/text/template/ diff --git a/docs/i18n/tr-TR/docusaurus-theme-classic/footer.json b/docs/i18n/tr-TR/docusaurus-theme-classic/footer.json deleted file mode 100644 index f6e423aa..00000000 --- a/docs/i18n/tr-TR/docusaurus-theme-classic/footer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "link.title.Pages": { - "message": "Sayfalar", - "description": "The title of the footer links column with title=Pages in the footer" - }, - "link.title.Community": { - "message": "Topluluk", - "description": "The title of the footer links column with title=Community in the footer" - }, - "link.title.Translations": { - "message": "Çeviriler", - "description": "The title of the footer links column with title=Translations in the footer" - }, - "link.item.label.Installation": { - "message": "Kurulum", - "description": "The label of footer link with label=Installation linking to /installation/" - }, - "link.item.label.Usage": { - "message": "Kullanım", - "description": "The label of footer link with label=Usage linking to /usage/" - }, - "link.item.label.Donate": { - "message": "Bağış Yap", - "description": "The label of footer link with label=Donate linking to /donate/" - }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/go-task/task" - }, - "link.item.label.Twitter": { - "message": "Twitter", - "description": "The label of footer link with label=Twitter linking to https://twitter.com/taskfiledev" - }, - "link.item.label.Mastodon": { - "message": "Mastodon", - "description": "The label of footer link with label=Mastodon linking to https://fosstodon.org/@task" - }, - "link.item.label.Discord": { - "message": "Discord", - "description": "The label of footer link with label=Discord linking to https://discord.gg/6TY36E39UK" - }, - "link.item.label.OpenCollective": { - "message": "OpenCollective", - "description": "The label of footer link with label=OpenCollective linking to https://opencollective.com/task" - } -} diff --git a/docs/i18n/tr-TR/docusaurus-theme-classic/navbar.json b/docs/i18n/tr-TR/docusaurus-theme-classic/navbar.json deleted file mode 100644 index ac0b7237..00000000 --- a/docs/i18n/tr-TR/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "title": { - "message": "Görev", - "description": "The title in the navbar" - }, - "item.label.Installation": { - "message": "Kurulum", - "description": "Navbar item with label Installation" - }, - "item.label.Usage": { - "message": "Kullanım", - "description": "Navbar item with label Usage" - }, - "item.label.API": { - "message": "API", - "description": "Navbar item with label API" - }, - "item.label.Donate": { - "message": "Bağış Yap", - "description": "Navbar item with label Donate" - }, - "item.label.GitHub": { - "message": "GitHub", - "description": "Navbar item with label GitHub" - }, - "item.label.Twitter": { - "message": "Twitter", - "description": "Navbar item with label Twitter" - }, - "item.label.Mastodon": { - "message": "Mastodon", - "description": "Navbar item with label Mastodon" - }, - "item.label.Discord": { - "message": "Discord", - "description": "Navbar item with label Discord" - } -} diff --git a/docs/i18n/zh-Hans/code.json b/docs/i18n/zh-Hans/code.json deleted file mode 100644 index 6b7d5530..00000000 --- a/docs/i18n/zh-Hans/code.json +++ /dev/null @@ -1,396 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "页面已崩溃。", - "description": "The title of the fallback page when the page crashed" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "重试", - "description": "The label of the button to try again when the page crashed" - }, - "theme.NotFound.title": { - "message": "找不到页面", - "description": "The title of the 404 page" - }, - "theme.NotFound.p1": { - "message": "我们找不到您要找的页面。", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "请联系原始链接来源网站的所有者，并告知他们链接已损坏。", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.admonition.note": { - "message": "备注", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "提示", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.danger": { - "message": "危险", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "信息", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.caution": { - "message": "警告", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "回到顶部", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "历史博文", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "历史博文", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "博文列表分页导航", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "较新的博文", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "较旧的博文", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "博文分页导航", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "较新一篇", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "较旧一篇", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "{count} 篇博文", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} 含有标签「{tagName}」", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "查看所有标签", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "切换浅色/暗黑模式（当前为{mode}）", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "暗黑模式", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "浅色模式", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.home": { - "message": "主页面", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "页面路径", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} 个项目", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "文档分页导航", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "上一页", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "下一页", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "{count} 篇文档带有标签", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged}「{tagName}」", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "版本：{versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "此为 {siteTitle} {versionLabel} 版尚未发行的文档。", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "此为 {siteTitle} {versionLabel} 版的文档，现已不再积极维护。", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "最新的文档请参阅 {latestVersionLink} ({versionLabel})。", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "最新版本", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "编辑此页", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "标题的直接链接", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": "于 {date} ", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": "由 {user} ", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "最后{byUser}{atDate}更新", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "选择版本", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "标签：", - "description": "The label alongside a tag list" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "关闭", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "最近博文导航", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "复制成功", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "复制代码到剪贴板", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "复制", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "切换自动换行", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "打开/收起侧边栏菜单「{label}」", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "选择语言", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "本页总览", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "阅读更多", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "阅读 {title} 的全文", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "阅读需 {readingTime} 分钟", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "收起侧边栏", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "收起侧边栏", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "关闭导航栏", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← 回到主菜单", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "切换导航栏", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "展开侧边栏", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "展开侧边栏", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.seeAll": { - "message": "查看全部 {count} 个结果" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "找到 {count} 份文件", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "「{query}」的搜索结果", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "在文档中搜索", - "description": "The search page title for empty query" - }, - "theme.SearchPage.inputPlaceholder": { - "message": "在此输入搜索字词", - "description": "The placeholder for search page input" - }, - "theme.SearchPage.inputLabel": { - "message": "搜索", - "description": "The ARIA label for search page input" - }, - "theme.SearchPage.algoliaLabel": { - "message": "通过 Algolia 搜索", - "description": "The ARIA label for Algolia mention" - }, - "theme.SearchPage.noResultsText": { - "message": "未找到任何结果", - "description": "The paragraph for empty search result" - }, - "theme.SearchPage.fetchingNewResults": { - "message": "正在获取新的搜索结果...", - "description": "The paragraph for fetching new search results" - }, - "theme.SearchBar.label": { - "message": "搜索", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchModal.searchBox.resetButtonTitle": { - "message": "清除查询", - "description": "The label and ARIA label for search box reset button" - }, - "theme.SearchModal.searchBox.cancelButtonText": { - "message": "取消", - "description": "The label and ARIA label for search box cancel button" - }, - "theme.SearchModal.startScreen.recentSearchesTitle": { - "message": "最近搜索", - "description": "The title for recent searches" - }, - "theme.SearchModal.startScreen.noRecentSearchesText": { - "message": "没有最近搜索", - "description": "The text when no recent searches" - }, - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { - "message": "保存这个搜索", - "description": "The label for save recent search button" - }, - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { - "message": "从历史记录中删除这个搜索", - "description": "The label for remove recent search button" - }, - "theme.SearchModal.startScreen.favoriteSearchesTitle": { - "message": "收藏", - "description": "The title for favorite searches" - }, - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { - "message": "从收藏列表中删除这个搜索", - "description": "The label for remove favorite search button" - }, - "theme.SearchModal.errorScreen.titleText": { - "message": "无法获取结果", - "description": "The title for error screen of search modal" - }, - "theme.SearchModal.errorScreen.helpText": { - "message": "你可能需要检查网络连接。", - "description": "The help text for error screen of search modal" - }, - "theme.SearchModal.footer.selectText": { - "message": "选中", - "description": "The explanatory text of the action for the enter key" - }, - "theme.SearchModal.footer.selectKeyAriaLabel": { - "message": "Enter 键", - "description": "The ARIA label for the Enter key button that makes the selection" - }, - "theme.SearchModal.footer.navigateText": { - "message": "导航", - "description": "The explanatory text of the action for the Arrow up and Arrow down key" - }, - "theme.SearchModal.footer.navigateUpKeyAriaLabel": { - "message": "向上键", - "description": "The ARIA label for the Arrow up key button that makes the navigation" - }, - "theme.SearchModal.footer.navigateDownKeyAriaLabel": { - "message": "向下键", - "description": "The ARIA label for the Arrow down key button that makes the navigation" - }, - "theme.SearchModal.footer.closeText": { - "message": "关闭", - "description": "The explanatory text of the action for Escape key" - }, - "theme.SearchModal.footer.closeKeyAriaLabel": { - "message": "Esc 键", - "description": "The ARIA label for the Escape key button that close the modal" - }, - "theme.SearchModal.footer.searchByText": { - "message": "搜索提供", - "description": "The text explain that the search is making by Algolia" - }, - "theme.SearchModal.noResultsScreen.noResultsText": { - "message": "没有结果：", - "description": "The text explains that there are no results for the following search" - }, - "theme.SearchModal.noResultsScreen.suggestedQueryText": { - "message": "试试搜索", - "description": "The text for the suggested query when no results are found for the following search" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsText": { - "message": "认为这个查询应该有结果？", - "description": "The text for the question where the user thinks there are missing results" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { - "message": "请告知我们。", - "description": "The text for the link to report missing results" - }, - "theme.SearchModal.placeholder": { - "message": "搜索文档", - "description": "The placeholder of the input of the DocSearch pop-up modal" - }, - "theme.common.skipToMainContent": { - "message": "跳到主要内容", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "标签", - "description": "The title of the tag list page" - } -} diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md deleted file mode 100644 index 42d99117..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-blog/2023-09-02-introducing-experiments.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Introducing Experiments -description: A look at where task is, where it's going and how we're going to get there. -slug: task-in-2023 -authors: - - pd93 -tags: - - experiments - - breaking-changes - - roadmap - - v4 -image: https://i.imgur.com/mErPwqL.png -hide_table_of_contents: false ---- - -Lately, Task has been growing extremely quickly and I've found myself thinking a lot about the future of the project and how we continue to evolve and grow. I'm not much of a writer, but I think one of the things we could do better is to communicate these kinds of thoughts to the community. So, with that in mind, this is the first (hopefully of many) blog posts talking about Task and what we're up to. - - - -## :calendar: So, what have we been up to? - -Over the past 12 months or so, [@andreynering][] (Author and maintainer of the project) and I ([@pd93][]) have been working in our spare time to maintain and improve v3 of Task and we've made some amazing progress. Here are just some of the things we've released in that time: - -- An official [extension for VS Code][vscode-task]. -- Internal Tasks ([#818](https://github.com/go-task/task/pull/818)). -- Task aliases ([#879](https://github.com/go-task/task/pull/879)). -- Looping over tasks ([#1220](https://github.com/go-task/task/pull/1200)). -- A series of refactors to the core codebase to make it more maintainable and extensible. -- Loads of bug fixes and improvements. -- An integration with [Crowdin][crowdin]. Work is in progress on making our docs available in **7 new languages** (Special thanks to all our translators for the huge help with this!). -- And much, much more! :sparkles: - -We're also working on adding some really exciting and highly requested features to Task such as having the ability to run remote Taskfiles ([#1317](https://github.com/go-task/task/issues/1317)). - -None of this would have been possible without the [150 or so (and growing) contributors][contributors] to the project, numerous sponsors and a passionate community of users. Together we have more than doubled the number of GitHub stars to over 8400 :star: since the beginning of 2022 and this continues to accelerate. We can't thank you all enough for your help and support! :rocket: - -[![Star History Chart](https://api.star-history.com/svg?repos=go-task/task&type=Date)](https://star-history.com/#go-task/task&Date) - -## What's next? :thinking: - -It's extremely motivating to see so many people using and loving Task. However, in this time we've also seen an increase in the number of issues and feature requests. In particular, issues that require some kind of breaking change to Task. This isn't a bad thing, but as we grow we need to be more responsible about how we address these changes in a way that ensures stability and compatibility for existing users and their Taskfiles. - -At this point you're probably thinking something like: - -> "But you use [semantic versioning][semver] - Just release a new major version with your breaking changes." - -And you'd be right... sort of. In theory, this sounds great, but the reality is that we don't have the time to commit to a major overhaul of Task in one big bang release. This would require a colossal amount of time and coordination and with full time jobs and personal lives to tend to, this is a difficult commitment to make. Smaller, more frequent major releases are also a significant inconvenience for users as they have to constantly keep up-to-date with our breaking changes. Fortunately, there is a better way. - -## What's going to change? :monocle: - -Going forwards, breaking changes will be allowed into _minor_ versions of Task as "experimental features". To access these features users will need opt-in by enabling feature flags. This will allow us to release new features slowly and gather feedback from the community before making them the default behavior in a future major release. - -To prepare users for the next major release, we will maintain a list of [deprecated features][deprecations] and [experiments][experiments] on our docs website and publish information on how to migrate to the new behavior. - -You can read the [full breaking change proposal][breaking-change-proposal] and view all the [current experiments and their status][experiments-project] on GitHub including the [Gentle Force][gentle-force-experiment] and [Remote Taskfiles][remote-taskfiles-experiment] experiments. - -## What will happen to v2/v3 features? - -v2 has been [officially deprecated][deprecate-version-2-schema]. If you're still using a Taskfile with `version: "2"` at the top we _strongly recommend_ that you upgrade as soon as possible. Removing v2 will allow us to tidy up the codebase and focus on new functionality instead. - -When v4 is released, we will continue to support v3 for a period of time (bug fixes etc). However, since we are moving from a backward-compatibility model to a forwards-compatibility model, **v4 itself will not be backwards compatible with v3**. - -## v4 When? :eyes: - -:man_shrugging: When it's ready. - -In all seriousness, we don't have a timeline for this yet. We'll be working on the most serious deficiencies of the v3 API first and regularly evaluating the state of the project. When we feel its in a good, stable place and we have a clear upgrade path for users and a number of stable experiments, we'll start to think about v4. - -## :wave: Final thoughts - -Task is growing fast and we're excited to see where it goes next. We hope that the steps we're taking to improve the project and our process will help us to continue to grow. As always, if you have any questions or feedback, we encourage you to comment on or open [issues][issues] and [discussions][discussions] on GitHub. Alternatively, you can join us on [Discord][discord]. - -I plan to write more of these blog posts in the future on a variety of Task-related topics, so make sure to check in occasionally and see what we're up to! - - - - -[vscode-task]: https://github.com/go-task/vscode-task -[crowdin]: https://crowdin.com -[contributors]: https://github.com/go-task/task/graphs/contributors -[semver]: https://semver.org -[breaking-change-proposal]: https://github.com/go-task/task/discussions/1191 -[@andreynering]: https://github.com/andreynering -[@pd93]: https://github.com/pd93 -[experiments]: https://taskfile.dev/experiments -[deprecations]: https://taskfile.dev/deprecations -[deprecate-version-2-schema]: https://github.com/go-task/task/issues/1197 -[issues]: https://github.com/go-task/task/issues -[discussions]: https://github.com/go-task/task/discussions -[discord]: https://discord.gg/6TY36E39UK -[experiments-project]: https://github.com/orgs/go-task/projects/1 -[gentle-force-experiment]: https://github.com/go-task/task/issues/1200 -[remote-taskfiles-experiment]: https://github.com/go-task/task/issues/1317 diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-blog/authors.yml b/docs/i18n/zh-Hans/docusaurus-plugin-content-blog/authors.yml deleted file mode 100644 index 1bb46546..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-blog/authors.yml +++ /dev/null @@ -1,10 +0,0 @@ -andreynering: - name: Andrey Nering - title: Task 项目维护者 - url: https://github.com/andreynering - image_url: https://github.com/andreynering.png -pd93: - name: Pete Davison - title: Maintainer of Task - url: https://github.com/pd93 - image_url: https://github.com/pd93.png diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index dd30528d..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version.label": { - "message": "Next", - "description": "The label for version current" - } -} diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api_reference.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api_reference.md deleted file mode 100644 index 1858817a..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api_reference.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -slug: /api/ -sidebar_position: 4 -toc_min_heading_level: 2 -toc_max_heading_level: 5 ---- - -# API 参考 - -## 命令行 - -该命令的语法如下： - -```bash -task [--flags] [tasks...] [-- CLI_ARGS...] -``` - -:::tip - -If `--` is given, all remaining arguments will be assigned to a special `CLI_ARGS` variable - -::: - -| 缩写 | 标志 | 类型 | 默认 | 描述 | -| ---- | --------------------------- | -------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-c` | `--color` | `bool` | `true` | 彩色输出。 默认开启。 设置为 `false` 或使用 `NO_COLOR=1` 禁用。 | -| `-C` | `--concurrency` | `int` | `0` | 限制并发运行的 task 数。 零意味着无限。 | -| `-d` | `--dir` | `string` | 工作目录 | 设置执行目录。 | -| `-n` | `--dry` | `bool` | `false` | 按运行顺序编译和打印 task，而不执行它们。 | -| `-x` | `--exit-code` | `bool` | `false` | 传递 task 命令的退出代码。 | -| `-f` | `--force` | `bool` | `false` | 即使 task 是最新的也强制执行。 | -| `-g` | `--global` | `bool` | `false` | 从 `$HOME/Taskfile.{yml,yaml}` 运行全局 Taskfile。 | -| `-h` | `--help` | `bool` | `false` | 显示 Task 使用情况。 | -| `-i` | `--init` | `bool` | `false` | 在当前目录创建一个新的 Taskfile.yml。 | -| `-I` | `--interval` | `string` | `5s` | 使用 `--watch` 设置不同的观察间隔，默认为 5 秒。 这个字符串应该是一个有效的 [Go Duration](https://pkg.go.dev/time#ParseDuration)。 | -| `-l` | `--list` | `bool` | `false` | 列出当前文件的全部 task 及对应描述。 | -| `-a` | `--list-all` | `bool` | `false` | 列出无论有没有描述的所有 task。 | -| | `--sort` | `string` | `default` | Changes the order of the tasks when listed.
`default` - Alphanumeric with root tasks first
`alphanumeric` - Alphanumeric
`none` - No sorting (As they appear in the Taskfile) | -| | `--json` | `bool` | `false` | 查看 [JSON 输出](#json-输出) | -| `-o` | `--output` | `string` | 在 Taskfile 中设置默认值或 `intervealed` | 设置输出样式：[`interleaved`/`group`/`prefixed`]。 | -| | `--output-group-begin` | `string` | | 在任务组输出前打印的消息模板。 | -| | `--output-group-end` | `string` | | 在任务组输出后打印的消息模板。 | -| | `--output-group-error-only` | `bool` | `false` | 在退出码为 0 时忽略命令输出。 | -| `-p` | `--parallel` | `bool` | `false` | 并行执行命令行上提供的 task。 | -| `-s` | `--silent` | `bool` | `false` | 禁用回显。 | -| `-y` | `--yes` | `bool` | `false` | Assume "yes" as answer to all prompts. | -| | `--status` | `bool` | `false` | 如果任何给定 task 不是最新的，则以非 0 退出码退出。 | -| | `--summary` | `bool` | `false` | 显示有关 task 的摘要。 | -| `-t` | `--taskfile` | `string` | `Taskfile.yml` 或 `Taskfile.yaml` | | -| `-v` | `--verbose` | `bool` | `false` | 启用详细模式。 | -| | `--version` | `bool` | `false` | 显示 Task 版本。 | -| `-w` | `--watch` | `bool` | `false` | 启用给定 task 的观察器。 | - -## 退出码 - -Task 有时会以特定的退出代码退出。 These codes are split into three groups with the following ranges: - -- General errors (0-99) -- Taskfile errors (100-199) -- Task errors (200-299) - -可以在下面找到退出代码及其描述的完整列表： - -| 代码 | 描述 | -| --- | -------------------------------------------------------- | -| 0 | 成功 | -| 1 | 出现未知错误 | -| 100 | 找不到 Taskfile | -| 101 | 尝试初始化一个 Taskfile 时已经存在 | -| 102 | Taskfile 无效或无法解析 | -| 103 | A remote Taskfile could not be downloaded | -| 104 | A remote Taskfile was not trusted by the user | -| 105 | A remote Taskfile was could not be fetched securely | -| 106 | No cache was found for a remote Taskfile in offline mode | -| 107 | No schema version was defined in the Taskfile | -| 200 | 找不到指定的 task | -| 201 | 在 task 中执行命令时出错 | -| 202 | 用户试图调用内部 task | -| 203 | 有多个具有相同名称或别名的 task | -| 204 | 一个 task 被调用了太多次 | -| 205 | 操作被用户取消 | -| 206 | 由于缺少所需变量，任务未执行 | - -这些代码也可以在代码库的 [`errors/errors.go`](https://github.com/go-task/task/blob/main/errors/errors.go) 文件中找到。 - -:::info - -当使用 `-x`/`--exit-code` 标志运行 Task 时，任何失败命令的退出代码都将传递给用户。 - -::: - -## JSON 输出 - -将 `--json` 标志与 `--list` 或 `--list-all` 标志结合使用时，将输出具有以下结构的 JSON 对象： - -```json -{ - "tasks": [ - { - "name": "", - "desc": "", - "summary": "", - "up_to_date": false, - "location": { - "line": 54, - "column": 3, - "taskfile": "/path/to/Taskfile.yml" - } - } - // ... - ], - "location": "/path/to/Taskfile.yml" -} -``` - -## 特殊变量 - -模板系统上有一些可用的特殊变量： - -| 变量 | 描述 | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------- | -| `CLI_ARGS` | 当通过 CLI 调用 Task 时，传递包含在 `--` 之后的所有额外参数。 | -| `CLI_FORCE` | A boolean containing whether the `--force` or `--force-all` flags were set. | -| `TASK` | 当前 task 的名称。 | -| `ROOT_DIR` | 根 Taskfile 的绝对路径。 | -| `TASKFILE_DIR` | 包含 Taskfile 的绝对路径 | -| `USER_WORKING_DIR` | 调用 `task` 的目录的绝对路径。 | -| `CHECKSUM` | 在 `sources` 中列出的文件的 checksum。 仅在 `status` 参数中可用，并且如果 method 设置为 `checksum`。 | -| `TIMESTAMP` | The date object of the greatest timestamp of the files listed in `sources`. 仅在 `status` 参数中可用，并且如果 method 设置为 `timestamp`。 | -| `TASK_VERSION` | Task 的当前版本。 | -| `ITEM` | The value of the current iteration when using the `for` property. Can be changed to a different variable name using `as:`. | - -## 环境变量 - -Some environment variables can be overridden to adjust Task behavior. - -| ENV | 默认 | 描述 | -| -------------------- | ------- | ------------------------------------------------------------ | -| `TASK_TEMP_DIR` | `.task` | 临时目录的位置。 可以相对于项目比如 `tmp/task` 或绝对如 `/tmp/.task` 或 `~/.task`。 | -| `TASK_COLOR_RESET` | `0` | 用于白色的颜色。 | -| `TASK_COLOR_BLUE` | `34` | 用于蓝色的颜色。 | -| `TASK_COLOR_GREEN` | `32` | 用于绿色的颜色。 | -| `TASK_COLOR_CYAN` | `36` | 用于青色的颜色。 | -| `TASK_COLOR_YELLOW` | `33` | 用于黄色的颜色。 | -| `TASK_COLOR_MAGENTA` | `35` | 用于洋红色的颜色。 | -| `TASK_COLOR_RED` | `31` | 用于红色的颜色。 | -| `FORCE_COLOR` | | 强制使用颜色输出。 | - -## Taskfile Schema - -| 属性 | 类型 | 默认 | 描述 | -| ---------- | ---------------------------------- | ------------- | ------------------------------------------------------------------------------------------------- | -| `version` | `string` | | Taskfile 的版本。 当前版本是 `3`。 | -| `output` | `string` | `interleaved` | 输出模式。 可用选项: `interleaved`、`group` 和 `prefixed` | -| `method` | `string` | `checksum` | Taskfile 中的默认方法。 Can be overridden in a task by task basis. 可用选项：`checksum`、`timestamp` 和 `none`。 | -| `includes` | [`map[string]Include`](#include) | | 要包含的其他 Taskfile。 | -| `vars` | [`map[string]Variable`](#variable) | | 一组全局变量。 | -| `env` | [`map[string]Variable`](#variable) | | 一组全局环境变量。 | -| `tasks` | [`map[string]Task`](#task) | | 一组 task 定义。 | -| `silent` | `bool` | `false` | 此 Taskfile 的默认“silent”选项。 If `false`, can be overridden with `true` in a task by task basis. | -| `dotenv` | `[]string` | | 要解析的 `.env` 文件路径列表。 | -| `run` | `string` | `always` | Taskfile 中默认的 'run' 选项。 可用选项: `always`、`once` 和 `when_changed`。 | -| `interval` | `string` | `5s` | 设置 `--watch` 模式下的观察时间，默认 5 秒。 这个字符串应该是一个有效的 [Go Duration](https://pkg.go.dev/time#ParseDuration)。 | -| `set` | `[]string` | | 为 [内置 `set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) 指定选项。 | -| `shopt` | `[]string` | | 为 [内置 `shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) 指定选项。 | - -### Include - -| 属性 | 类型 | 默认 | 描述 | -| ---------- | --------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------ | -| `taskfile` | `string` | | 要包含的 Taskfile 或目录的路径。 如果是目录，Task 将在该目录中查找名为 `Taskfile.yml` 或 `Taskfile.yaml` 的文件。 如果是相对路径，则相对于包含 Taskfile 的目录进行解析。 | -| `dir` | `string` | Taskfile 文件父目录 | 运行时包含的 task 的工作目录。 | -| `optional` | `bool` | `false` | 设置为 `true` 时, 文件不存在也不会报错 | -| `internal` | `bool` | `false` | 停止在命令行上调用包含的 Taskfile 中的任何 task。 当与 `--list` 一起使用时，这些命令也将从输出中省略。 | -| `aliases` | `[]string` | | 包含的 Taskfile 的命名空间的替代名称。 | -| `vars` | `map[string]Variable` | | 一组应用于包含的 Taskfile 的变量。 | - -:::info - -像下面这样只赋值一个字符串，和把这个值设置到 `taskfile` 属性是一样的。 - -```yaml -includes: - foo: ./path -``` - -::: - -### Variable - -| 属性 | 类型 | 默认 | 描述 | -| -------- | -------- | -- | ---------------------------------- | -| _itself_ | `string` | | 将设置为变量的静态值。 | -| `sh` | `string` | | 一个 shell 命令。 输出 (`STDOUT`) 将分配给变量。 | - -:::info - -静态和动态变量有不同的语法，如下所示： - -```yaml -vars: - STATIC: static - DYNAMIC: - sh: echo "dynamic" -``` - -::: - -### Task - -| 属性 | 类型 | 默认 | 描述 | -| --------------- | ---------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `cmds` | [`[]Command`](#command) | | 要执行的 shell 命令列表。 | -| `deps` | [`[]Dependency`](#dependency) | | 此 task 的依赖项列表。 此处定义的 task 将在此 task 之前并行运行。 | -| `label` | `string` | | 运行 task 时覆盖输出中的 task 名称。 支持变量。 | -| `desc` | `string` | | task 的简短描述。 这在调用 `task --list` 时显示。 | -| `prompt` | `string` | | A prompt that will be presented before a task is run. Declining will cancel running the current and any subsequent tasks. | -| `summary` | `string` | | task 的较长描述。 这在调用 `task --summary [task]` 时显示。 | -| `aliases` | `[]string` | | 可以调用 task 的别名列表。 | -| `sources` | `[]string` | | 运行此 task 之前要检查的源列表。 与 `checksum` 和 `timestamp` 方法相关。 可以是文件路径或星号。 | -| `generates` | `[]string` | | 此 task 要生成的文件列表。 与 `timestamp` 方法相关。 可以是文件路径或星号。 | -| `status` | `[]string` | | 用于检查此 task 是否应运行的命令列表。 否则跳过该 task。 这个方法会覆盖 `method`、`sources` 和 `generates`。 | -| `requires` | `[]string` | | A list of variables which should be set if this task is to run, if any of these variables are unset the task will error and not run. | -| `preconditions` | [`[]Precondition`](#precondition) | | 用于检查此 task 是否应运行的命令列表。 如果不满足条件，task 将出错。 | -| `requires` | [`Requires`](#requires) | | A list of required variables which should be set if this task is to run, if any variables listed are unset the task will error and not run. | -| `dir` | `string` | | 此 task 应运行的目录。 默认为当前工作目录。 | -| `vars` | [`map[string]Variable`](#variable) | | 可在 task 中使用的一组变量。 | -| `env` | [`map[string]Variable`](#variable) | | 一组可用于 shell 命令的环境变量。 | -| `dotenv` | `[]string` | | 要解析的 `.env` 文件路径列表。 | -| `silent` | `bool` | `false` | 从输出中隐藏 task 名称和命令。 命令的输出仍将重定向到 `STDOUT` 和 `STDERR`。 当与 `--list` 标志结合使用时，task 描述将被隐藏。 | -| `interactive` | `bool` | `false` | 告诉 task 该命令是交互式的。 | -| `internal` | `bool` | `false` | 停止在命令行上调用 task。 当与 `--list` 一起使用时，它也会从输出中省略。 | -| `method` | `string` | `checksum` | 定义用于检查 task 是最新的方法。 `timestamp` 将比较 sources 的时间戳并生成文件。 `checksum` 将检查 checksum（您可能想忽略 .gitignore 文件中的 .task 文件夹）。 `none` 跳过任何验证并始终运行 task。 | -| `prefix` | `string` | | 定义一个字符串作为并行运行 task 输出的前缀。 仅在输出模式是 `prefixed` 时使用。 | -| `ignore_error` | `bool` | `false` | 如果执行命令时发生错误，则继续执行。 | -| `run` | `string` | Taskfile 中全局声明的值或 `always` | 指定如果多次调用该 task 是否应再次运行。 可用选项：`always`、`once` 和 `when_changed`。 | -| `platforms` | `[]string` | 所有平台 | 指定应在哪些平台上运行 task。 允许使用 [有效的 GOOS 和 GOARCH 值](https://github.com/golang/go/blob/main/src/go/build/syslist.go)。 否则将跳过 task。 | -| `set` | `[]string` | | 为 [内置 `set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) 指定选项。 | -| `shopt` | `[]string` | | 为 [内置 `shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) 指定选项。 | - -:::info - -这些替代语法可用。 他们会将给定值设置为 `cmds`，其他所有内容都将设置为其默认值： - -```yaml -tasks: - foo: echo "foo" - - foobar: - - echo "foo" - - echo "bar" - - baz: - cmd: echo "baz" -``` - -::: - -#### Command - -| 属性 | 类型 | 默认 | 描述 | -| -------------- | ---------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------- | -| `cmd` | `string` | | 要执行的 shell 命令 | -| `task` | `string` | | 执行另一个 task，而不执行命令。 不能与 `cmd` 同时设置。 | -| `for` | [`For`](#for) | | Runs the command once for each given value. | -| `silent` | `bool` | `false` | 跳过此命令的一些输出。 请注意，命令的 STDOUT 和 STDERR 仍将被重定向。 | -| `vars` | [`map[string]Variable`](#variable) | | 要传递给引用 task 的可选附加变量。 仅在设置 `task` 而不是 `cmd` 时相关。 | -| `ignore_error` | `bool` | `false` | 执行命令的时候忽略错误，继续执行 | -| `defer` | `string` | | `cmd` 的替代方法，但安排命令在此 task 结束时执行，而不是立即执行。 不能与 `cmd` 一同使用。 | -| `platforms` | `[]string` | 所有平台 | 指定应在哪些平台上运行该命令。 允许使用 [有效的 GOOS 和 GOARCH 值](https://github.com/golang/go/blob/main/src/go/build/syslist.go)。 否则将跳过命令。 | -| `set` | `[]string` | | 为 [内置 `set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) 指定选项。 | -| `shopt` | `[]string` | | 为 [内置 `shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) 指定选项。 | - -:::info - -如果以字符串形式给出，该值将分配给 `cmd`： - -```yaml -tasks: - foo: - cmds: - - echo "foo" - - echo "bar" -``` - -::: - -#### Dependency - -| 属性 | 类型 | 默认 | 描述 | -| -------- | ---------------------------------- | ------- | --------------------------------------------------- | -| `task` | `string` | | 要作为依赖项执行的 task。 | -| `vars` | [`map[string]Variable`](#variable) | | 要传递给此 task 的可选附加变量。 | -| `silent` | `bool` | `false` | 从输出中隐藏 task 名称和命令。 命令的输出仍将重定向到 `STDOUT` 和 `STDERR`。 | - -:::tip - -如果你不想设置额外的变量，将依赖关系声明为一个字符串列表就足够了（它们将被分配给 `task`）。 - -```yaml -tasks: - foo: - deps: [foo, bar] -``` - -::: - -#### For - -The `for` parameter can be defined as a string, a list of strings or a map. If it is defined as a string, you can give it any of the following values: - -- `source` - Will run the command for each source file defined on the task. (Glob patterns will be resolved, so `*.go` will run for every Go file that matches). - -If it is defined as a list of strings, the command will be run for each value. - -Finally, the `for` parameter can be defined as a map when you want to use a variable to define the values to loop over: - -| 属性 | 类型 | 默认 | 描述 | -| ------- | -------- | ---------------- | -------------------------------------------- | -| `var` | `string` | | The name of the variable to use as an input. | -| `split` | `string` | (any whitespace) | What string the variable should be split on. | -| `as` | `string` | `ITEM` | The name of the iterator variable. | - -#### Precondition - -| Attribute | Type | Default | Description | -| --------- | -------- | ------- | --------------------------------------- | -| `sh` | `string` | | 要执行的命令。 如果返回非零退出码， task 将在不执行其命令的情况下出错。 | -| `msg` | `string` | | 如果不满足先决条件，则打印可选消息。 | - -:::tip - -如果你不想设置不同的消息，你可以像这样声明一个前提条件，值将被分配给 `sh`： - -```yaml -tasks: - foo: - precondition: test -f Taskfile.yml -``` - -::: - -#### Requires - -| Attribute | Type | Default | Description | -| --------- | ---------- | ------- | -------------------------------------------------------------------------------------------------- | -| `vars` | `[]string` | | List of variable or environment variable names that must be set if this task is to execute and run | diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/changelog.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/changelog.md deleted file mode 100644 index 7f35d828..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/changelog.md +++ /dev/null @@ -1,573 +0,0 @@ ---- -slug: /changelog/ -sidebar_position: 14 ---- - -# 更新日志 - -## v3.33.1 - 2023-12-21 - -- Added support for looping over map variables with the [Any Variables experiment](https://taskfile.dev/experiments/any_variables) enabled (#1435, #1437 by @pd93). -- Fixed a bug where dynamic variables were causing errors during fast compilation (#1435, #1437 by @pd93) - -## v3.33.0 - 2023-12-20 - -- Added [Any Variables experiment](https://taskfile.dev/experiments/any-variables) (#1415, #1421 by @pd93). -- Updated Docusaurus to v3 (#1432 by @pd93). -- Added `aliases` to `--json` flag output (#1430, #1431 by @pd93). -- Added new `CLI_FORCE` special variable containing whether the `--force` or `--force-all` flags were set (#1412, #1434 by @pd93). - -## v3.32.0 - 2023-11-29 - -- Added ability to exclude some files from `sources:` by using `exclude:` (#225, - - # 1324 by @pd93 and @andreynering). -- The [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) now prefers remote files over cached ones by default (#1317, #1345 by @pd93). -- Added `--timeout` flag to the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1345 by @pd93). -- Fix bug where dynamic `vars:` and `env:` were being executed when they should actually be skipped by `platforms:` (#1273, #1377 by @andreynering). -- Fix `schema.json` to make `silent` valid in `cmds` that use `for` (#1385, - - # 1386 by @iainvm). -- Add new `--no-status` flag to skip expensive status checks when running `task --list --json` (#1348, #1368 by @amancevice). - -## v3.31.0 - 2023-10-07 - -- Enabled the `--yes` flag for the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) (#1317, #1344 by @pd93). -- Add ability to set `watch: true` in a task to automatically run it in watch mode (#231, #1361 by @andreynering). -- Fixed a bug on the watch mode where paths that contained `.git` (like `.github`), for example, were also being ignored (#1356 by @butuzov). -- Fixed a nil pointer error when running a Taskfile with no contents (#1341, - - # 1342 by @pd93). -- Added a new [exit code](https://taskfile.dev/api/#exit-codes) (107) for when a Taskfile does not contain a schema version (#1342 by @pd93). -- Increased limit of maximum task calls from 100 to 1000 for now, as some people have been reaching this limit organically now that we have loops. This check exists to detect recursive calls, but will be removed in favor of a better algorithm soon (#1321, #1332). -- Fixed templating on descriptions on `task --list` (#1343 by @blackjid). -- Fixed a bug where precondition errors were incorrectly being printed when task execution was aborted (#1337, #1338 by @sylv-io). - -## v3.30.1 - 2023-09-14 - -- Fixed a regression where some special variables weren't being set correctly (#1331, #1334 by @pd93). - -## v3.30.0 - 2023-09-13 - -- Prep work for Remote Taskfiles (#1316 by @pd93). -- Added the [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) as a draft (#1152, #1317 by @pd93). -- Improve performance of content checksuming on `sources:` by replacing md5 with [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking change because checksums will be invalidated when upgrading to this release (#1325 by @ReillyBrogan). - -## v3.29.1 - 2023-08-26 - -- Update to Go 1.21 (bump minimum version to 1.20) (#1302 by @pd93) -- Fix a missing a line break on log when using `--watch` mode (#1285, #1297 by @FilipSolich). -- Fix `defer` on JSON Schema (#1288 by @calvinmclean and @andreynering). -- Fix bug in usage of special variables like `{{.USER_WORKING_DIR}}` in combination with `includes` (#1046, #1205, #1250, #1293, #1312, #1274 by @andarto, #1309 by @andreynering). -- Fix bug on `--status` flag. Running this flag should not have side-effects: it should not update the checksum on `.task`, only report its status (#1305, - - # 1307 by @visciang, #1313 by @andreynering). - -## v3.28.0 - 2023-07-24 - -- Added the ability to [loop over commands and tasks](https://taskfile.dev/usage/#looping-over-values) using `for` (#82, #1220 by @pd93). -- Fixed variable propagation in multi-level includes (#778, #996, #1256 by @hudclark). -- Fixed a bug where the `--exit-code` code flag was not returning the correct exit code when calling commands indirectly (#1266, #1270 by @pd93). -- Fixed a `nil` panic when a dependency was commented out or left empty (#1263 by @neomantra). - -## v3.27.1 - 2023-06-30 - -- Fix panic when a `.env` directory (not file) is present on current directory (#1244, #1245 by @pd93). - -## v3.27.0 - 2023-06-29 - -- Allow Taskfiles starting with lowercase characters (#947, #1221 by @pd93). - - e.g. `taskfile.yml`, `taskfile.yaml`, `taskfile.dist.yml` & `taskfile.dist.yaml` -- Bug fixes were made to the [npm installation method](https://taskfile.dev/installation/#npm). (#1190, by @sounisi5011). -- Added the [gentle force experiment](https://taskfile.dev/experiments/gentle-force) as a draft (#1200, #1216 by @pd93). -- Added an `--experiments` flag to allow you to see which experiments are enabled (#1242 by @pd93). -- Added ability to specify which variables are required in a task (#1203, #1204 by @benc-uk). - -## v3.26.0 - 2023-06-10 - -- Only rewrite checksum files in `.task` if the checksum has changed (#1185, - - # 1194 by @deviantintegral). -- Added [experiments documentation](https://taskfile.dev/experiments) to the website (#1198 by @pd93). -- Deprecated `version: 2` schema. This will be removed in the next major release (#1197, #1198, #1199 by @pd93). -- Added a new `prompt:` prop to set a warning prompt to be shown before running a potential dangurous task (#100, #1163 by @MaxCheetham, [Documentation](https://taskfile.dev/usage/#warning-prompts)). -- Added support for single command task syntax. With this change, it's now possible to declare just `cmd:` in a task, avoiding the more complex `cmds: []` when you have only a single command for that task (#1130, #1131 by @timdp). - -## v3.25.0 - 2023-05-22 - -- Support `silent:` when calling another tasks (#680, #1142 by @danquah). -- Improve PowerShell completion script (#1168 by @trim21). -- Add more languages to the website menu and show translation progress percentage (#1173 by @misitebao). -- Starting on this release, official binaries for FreeBSD will be available to download (#1068 by @andreynering). -- Fix some errors being unintendedly supressed (#1134 by @clintmod). -- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - - # 1149 by @pd93). -- Fix duplicate error message when a task does not exists (#1141, #1144 by @pd93). - -## v3.24.0 - 2023-04-15 - -- Fix Fish shell completion for tasks with aliases (#1113 by @patricksjackson). -- The default branch was renamed from `master` to `main` (#1049, #1048 by @pd93). -- Fix bug where "up-to-date" logs were not being omitted for silent tasks (#546, - - # 1107 by @danquah). -- Add `.hg` (Mercurial) to the list of ignored directories when using `--watch` (#1098 by @misery). -- More improvements to the release tool (#1096 by @pd93). -- Enforce [gofumpt](https://github.com/mvdan/gofumpt) linter (#1099 by @pd93) -- Add `--sort` flag for use with `--list` and `--list-all` (#946, #1105 by @pd93). -- Task now has [custom exit codes](https://taskfile.dev/api/#exit-codes) depending on the error (#1114 by @pd93). - -## v3.23.0 - 2023-03-26 - -Task now has an [official extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=task.vscode-task) contributed by @pd93! :tada:该扩展现在在 `go-task` 组织的 [新存储库](https://github.com/go-task/vscode-task) 中进行维护。 我们希望从社区收集反馈，请尝试并通过[discussion](https://github.com/go-task/vscode-task/discussions)、 [issue](https://github.com/go-task/vscode-task/issues) 或 [Discord](https://discord.gg/6TY36E39UK) 告诉我们您的想法！ - -> **注意：** 扩展 _需要安装_ v3.23.0 才能正常工作。 - -- The website was integrated with [Crowdin](https://crowdin.com/project/taskfile) to allow the community to contribute with translations! [Chinese](https://taskfile.dev/zh-Hans/) is the first language available (#1057, #1058 by @misitebao). -- Added task location data to the `--json` flag output (#1056 by @pd93) -- Change the name of the file generated by `task --init` from `Taskfile.yaml` to `Taskfile.yml` (#1062 by @misitebao). -- Added new `splitArgs` template function (`{{splitArgs "foo bar 'foo bar baz'"}}`) to ensure string is split as arguments (#1040, #1059 by @dhanusaputra). -- Fix the value of `{{.CHECKSUM}}` variable in status (#1076, #1080 by @pd93). -- Fixed deep copy implementation (#1072 by @pd93) -- Created a tool to assist with releases (#1086 by @pd93). - -## v3.22.0 - 2023-03-10 - -- Add a brand new `--global` (`-g`) flag that will run a Taskfile from your `$HOME` directory. This is useful to have automation that you can run from anywhere in your system! ([Documentation](https://taskfile.dev/usage/#running-a-global-taskfile), #1029 by @andreynering). -- Add ability to set `error_only: true` on the `group` output mode. This will instruct Task to only print a command output if it returned with a non-zero exit code (#664, #1022 by @jaedle). -- Fixed bug where `.task/checksum` file was sometimes not being created when task also declares a `status:` (#840, #1035 by @harelwa, #1037 by @pd93). -- Refactored and decoupled fingerprinting from the main Task executor (#1039 by @pd93). -- Fixed deadlock issue when using `run: once` (#715, #1025 by @theunrepentantgeek). - -## v3.21.0 - 2023-02-22 - -- Added new `TASK_VERSION` special variable (#990, #1014 by @ja1code). -- Fixed a bug where tasks were sometimes incorrectly marked as internal (#1007 by @pd93). -- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) -- Added environment variable `FORCE_COLOR` support to force color output. Usefull for environments without TTY (#1003 by @automation-stack) - -## v3.20.0 - 2023-01-14 - -- Improve behavior and performance of status checking when using the `timestamp` mode (#976, #977 by @aminya). -- Performance optimizations were made for large Taskfiles (#982 by @pd93). -- Add ability to configure options for the [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) and [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) builtins (#908, #929 by @pd93, [Documentation](http://taskfile.dev/usage/#set-and-shopt)). -- Add new `platforms:` attribute to `task` and `cmd`, so it's now possible to choose in which platforms that given task or command will be run on. Possible values are operating system (GOOS), architecture (GOARCH) or a combination of the two. Example: `platforms: [linux]`, `platforms: [amd64]` or `platforms: [linux/amd64]`. Other platforms will be skipped (#978, #980 by @leaanthony). - -## v3.19.1 - 2022-12-31 - -- Small bug fix: closing `Taskfile.yml` once we're done reading it (#963, #964 by @HeCorr). -- Fixes a bug in v2 that caused a panic when using a `Taskfile_{{OS}}.yml` file (#961, #971 by @pd93). -- Fixed a bug where watch intervals set in the Taskfile were not being respected (#969, #970 by @pd93) -- Add `--json` flag (alias `-j`) with the intent to improve support for code editors and add room to other possible integrations. This is basic for now, but we plan to add more info in the near future (#936 by @davidalpert, #764). - -## v3.19.0 - 2022-12-05 - -- Installation via npm now supports [pnpm](https://pnpm.io/) as well ([go-task/go-npm#2](https://github.com/go-task/go-npm/issues/2), [go-task/go-npm#3](https://github.com/go-task/go-npm/pull/3)). -- It's now possible to run Taskfiles from subdirectories! A new `USER_WORKING_DIR` special variable was added to add even more flexibility for monorepos (#289, #920). -- Add task-level `dotenv` support (#389, #904). -- It's now possible to use global level variables on `includes` (#942, #943). -- The website got a brand new [translation to Chinese](https://task-zh.readthedocs.io/zh_CN/latest/) by [@DeronW](https://github.com/DeronW). Thanks! - -## v3.18.0 - 2022-11-12 - -- Show aliases on `task --list --silent` (`task --ls`). This means that aliases will be completed by the completion scripts (#919). -- Tasks in the root Taskfile will now be displayed first in `--list`/`--list-all` output (#806, #890). -- It's now possible to call a `default` task in an included Taskfile by using just the namespace. For example: `docs:default` is now automatically aliased to `docs` (#661, #815). - -## v3.17.0 - 2022-10-14 - -- Add a "Did you mean ...?" suggestion when a task does not exits another one with a similar name is found (#867, #880). -- Now YAML parse errors will print which Taskfile failed to parse (#885, #887). -- Add ability to set `aliases` for tasks and namespaces (#268, #340, #879). -- Improvements to Fish shell completion (#897). -- Added ability to set a different watch interval by setting `interval: '500ms'` or using the `--interval=500ms` flag (#813, #865). -- Add colored output to `--list`, `--list-all` and `--summary` flags (#845, - - # 874). -- Fix unexpected behavior where `label:` was being shown instead of the task name on `--list` (#603, #877). - -## v3.16.0 - 2022-09-29 - -- Add `npm` as new installation method: `npm i -g @go-task/cli` (#870, #871, [npm package](https://www.npmjs.com/package/@go-task/cli)). -- Add support to marking tasks and includes as internal, which will hide them from `--list` and `--list-all` (#818). - -## v3.15.2 - 2022-09-08 - -- Fix error when using variable in `env:` introduced in the previous release (#858, #866). -- Fix handling of `CLI_ARGS` (`--`) in Bash completion (#863). -- On zsh completion, add ability to replace `--list-all` with `--list` as already possible on the Bash completion (#861). - -## v3.15.0 - 2022-09-03 - -- Add new special variables `ROOT_DIR` and `TASKFILE_DIR`. This was a highly requested feature (#215, #857, [Documentation](https://taskfile.dev/api/#special-variables)). -- Follow symlinks on `sources` (#826, #831). -- Improvements and fixes to Bash completion (#835, #844). - -## v3.14.1 - 2022-08-03 - -- Always resolve relative include paths relative to the including Taskfile (#822, #823). -- Fix ZSH and PowerShell completions to consider all tasks instead of just the public ones (those with descriptions) (#803). - -## v3.14.0 - 2022-07-08 - -- Add ability to override the `.task` directory location with the `TASK_TEMP_DIR` environment variable. -- Allow to override Task colors using environment variables: `TASK_COLOR_RESET`, `TASK_COLOR_BLUE`, `TASK_COLOR_GREEN`, `TASK_COLOR_CYAN`, `TASK_COLOR_YELLOW`, `TASK_COLOR_MAGENTA` and `TASK_COLOR_RED` (#568, #792). -- Fixed bug when using the `output: group` mode where STDOUT and STDERR were being print in separated blocks instead of in the right order (#779). -- Starting on this release, ARM architecture binaries are been released to Snap as well (#795). -- i386 binaries won't be available anymore on Snap because Ubuntu removed the support for this architecture. -- Upgrade mvdan.cc/sh, which fixes a bug with associative arrays (#785, [mvdan/sh#884](https://github.com/mvdan/sh/issues/884), [mvdan/sh#893](https://github.com/mvdan/sh/pull/893)). - -## v3.13.0 - 2022-06-13 - -- Added `-n` as an alias to `--dry` (#776, #777). -- Fix behavior of interrupt (SIGINT, SIGTERM) signals. Task will now give time for the processes running to do cleanup work (#458, #479, #728, #769). -- Add new `--exit-code` (`-x`) flag that will pass-through the exit form the command being ran (#755). - -## v3.12.1 - 2022-05-10 - -- Fixed bug where, on Windows, variables were ending with `\r` because we were only removing the final `\n` but not `\r\n` (#717). - -## v3.12.0 - 2022-03-31 - -- The `--list` and `--list-all` flags can now be combined with the `--silent` flag to print the task names only, without their description (#691). -- Added support for multi-level inclusion of Taskfiles. This means that included Taskfiles can also include other Taskfiles. Before this was limited to one level (#390, #623, #656). -- Add ability to specify vars when including a Taskfile. [Check out the documentation](https://taskfile.dev/#/usage?id=vars-of-included-taskfiles) for more information (#677). - -## v3.11.0 - 2022-02-19 - -- Task now supports printing begin and end messages when using the `group` output mode, useful for grouping tasks in CI systems. [Check out the documentation](http://taskfile.dev/#/usage?id=output-syntax) for more information (#647, #651). -- Add `Taskfile.dist.yml` and `Taskfile.dist.yaml` to the supported file name list. [Check out the documentation](https://taskfile.dev/#/usage?id=supported-file-names) for more information (#498, #666). - -## v3.10.0 - 2022-01-04 - -- A new `--list-all` (alias `-a`) flag is now available. It's similar to the exiting `--list` (`-l`) but prints all tasks, even those without a description (#383, #401). -- It's now possible to schedule cleanup commands to run once a task finishes with the `defer:` keyword ([Documentation](https://taskfile.dev/#/usage?id=doing-task-cleanup-with-defer), - - # 475, #626). -- Remove long deprecated and undocumented `$` variable prefix and `^` command prefix (#642, #644, #645). -- Add support for `.yaml` extension (as an alternative to `.yml`). This was requested multiple times throughout the years. Enjoy! (#183, #184, #369, #584, - - # 621). -- Fixed error when computing a variable when the task directory do not exist yet (#481, #579). - -## v3.9.2 - 2021-12-02 - -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains a fix a for a important regression on Windows (#619, [mvdan/sh#768](https://github.com/mvdan/sh/issues/768), [mvdan/sh#769](https://github.com/mvdan/sh/pull/769)). - -## v3.9.1 - 2021-11-28 - -- Add logging in verbose mode for when a task starts and finishes (#533, #588). -- Fix an issue with preconditions and context errors (#597, #598). -- Quote each `{{.CLI_ARGS}}` argument to prevent one with spaces to become many (#613). -- Fix nil pointer when `cmd:` was left empty (#612, #614). -- Upgrade [mvdan/sh](https://github.com/mvdan/sh) which contains two relevant fixes: - - Fix quote of empty strings in `shellQuote` (#609, [mvdan/sh#763](https://github.com/mvdan/sh/issues/763)). - - Fix issue of wrong environment variable being picked when there's another very similar one (#586, [mvdan/sh#745](https://github.com/mvdan/sh/pull/745)). -- Install shell completions automatically when installing via Homebrew (#264, #592, [go-task/homebrew-tap#2](https://github.com/go-task/homebrew-tap/pull/2)). - -## v3.9.0 - 2021-10-02 - -- A new `shellQuote` function was added to the template system (`{{shellQuote "a string"}}`) to ensure a string is safe for use in shell ([mvdan/sh#727](https://github.com/mvdan/sh/pull/727), [mvdan/sh#737](https://github.com/mvdan/sh/pull/737), [Documentation](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)) -- In this version [mvdan.cc/sh](https://github.com/mvdan/sh) was upgraded with some small fixes and features - - The `read -p` flag is now supported (#314, [mvdan/sh#551](https://github.com/mvdan/sh/issues/551), [mvdan/sh#772](https://github.com/mvdan/sh/pull/722)) - - The `pwd -P` and `pwd -L` flags are now supported (#553, [mvdan/sh#724](https://github.com/mvdan/sh/issues/724), [mvdan/sh#728](https://github.com/mvdan/sh/pull/728)) - - The `$GID` environment variable is now correctly being set (#561, [mvdan/sh#723](https://github.com/mvdan/sh/pull/723)) - -## v3.8.0 - 2021-09-26 - -- Add `interactive: true` setting to improve support for interactive CLI apps (#217, #563). -- Fix some `nil` errors (#534, #573). -- Add ability to declare an included Taskfile as optional (#519, #552). -- Add support for including Taskfiles in the home directory by using `~` (#539, #557). - -## v3.7.3 - 2021-09-04 - -- Add official support to Apple M1 (#564, #567). -- Our [official Homebrew tap](https://github.com/go-task/homebrew-tap) will support more platforms, including Apple M1 - -## v3.7.0 - 2021-07-31 - -- Add `run:` setting to control if tasks should run multiple times or not. Available options are `always` (the default), `when_changed` (if a variable modified the task) and `once` (run only once no matter what). This is a long time requested feature. Enjoy! (#53, #359). - -## v3.6.0 - 2021-07-10 - -- Allow using both `sources:` and `status:` in the same task (#411, #427, #477). -- Small optimization and bug fix: don't compute variables if not needed for `dotenv:` (#517). - -## v3.5.0 - 2021-07-04 - -- Add support for interpolation in `dotenv:` (#433, #434, #453). - -## v3.4.3 - 2021-05-30 - -- Add support for the `NO_COLOR` environment variable. (#459, [fatih/color#137](https://github.com/fatih/color/pull/137)). -- Fix bug where sources were not considering the right directory in `--watch` mode (#484, #485). - -## v3.4.2 - 2021-04-23 - -- On watch, report which file failed to read (#472). -- Do not try to catch SIGKILL signal, which are not actually possible (#476). -- Improve version reporting when building Task from source using Go Modules (#462, #473). - -## v3.4.1 - 2021-04-17 - -- Improve error reporting when parsing YAML: in some situations where you would just see an generic error, you'll now see the actual error with more detail: the YAML line the failed to parse, for example (#467). -- A JSON Schema was published [here](https://json.schemastore.org/taskfile.json) and is automatically being used by some editors like Visual Studio Code (#135). -- Print task name before the command in the log output (#398). - -## v3.3.0 - 2021-03-20 - -- Add support for delegating CLI arguments to commands with `--` and a special `CLI_ARGS` variable (#327). -- Add a `--concurrency` (alias `-C`) flag, to limit the number of tasks that run concurrently. This is useful for heavy workloads. (#345). - -## v3.2.2 - 2021-01-12 - -- Improve performance of `--list` and `--summary` by skipping running shell variables for these flags (#332). -- Fixed a bug where an environment in a Taskfile was not always overridable by the system environment (#425). -- Fixed environment from .env files not being available as variables (#379). -- The install script is now working for ARM platforms (#428). - -## v3.2.1 - 2021-01-09 - -- Fixed some bugs and regressions regarding dynamic variables and directories (#426). -- The [slim-sprig](https://github.com/go-task/slim-sprig) package was updated with the upstream [sprig](https://github.com/Masterminds/sprig). - -## v3.2.0 - 2021-01-07 - -- Fix the `.task` directory being created in the task directory instead of the Taskfile directory (#247). -- Fix a bug where dynamic variables (those declared with `sh:`) were not running in the task directory when the task has a custom dir or it was in an included Taskfile (#384). -- The watch feature (via the `--watch` flag) got a few different bug fixes and should be more stable now (#423, #365). - -## v3.1.0 - 2021-01-03 - -- Fix a bug when the checksum up-to-date resolution is used by a task with a custom `label:` attribute (#412). -- Starting from this release, we're releasing official ARMv6 and ARM64 binaries for Linux (#375, #418). -- Task now respects the order of declaration of included Taskfiles when evaluating variables declaring by them (#393). -- `set -e` is now automatically set on every command. This was done to fix an issue where multiline string commands wouldn't really fail unless the sentence was in the last line (#403). - -## v3.0.1 - 2020-12-26 - -- Allow use as a library by moving the required packages out of the `internal` directory (#358). -- Do not error if a specified dotenv file does not exist (#378, #385). -- Fix panic when you have empty tasks in your Taskfile (#338, #362). - -## v3.0.0 - 2020-08-16 - -- On `v3`, all CLI variables will be considered global variables (#336, #341) -- Add support to `.env` like files (#324, #356). -- Add `label:` to task so you can override the task name in the logs (#321, - - # 337). -- Refactor how variables work on version 3 (#311). -- Disallow `expansions` on v3 since it has no effect. -- `Taskvars.yml` is not automatically included anymore. -- `Taskfile_{{OS}}.yml` is not automatically included anymore. -- Allow interpolation on `includes`, so you can manually include a Taskfile based on operation system, for example. -- Expose `.TASK` variable in templates with the task name (#252). -- Implement short task syntax (#194, #240). -- Added option to make included Taskfile run commands on its own directory (#260, #144) -- Taskfiles in version 1 are not supported anymore (#237). -- Added global `method:` option. With this option, you can set a default method to all tasks in a Taskfile (#246). -- Changed default method from `timestamp` to `checksum` (#246). -- New magic variables are now available when using `status:`: `.TIMESTAMP` which contains the greatest modification date from the files listed in `sources:`, and `.CHECKSUM`, which contains a checksum of all files listed in `status:`. This is useful for manual checking when using external, or even remote, artifacts when using `status:` (#216). -- We're now using [slim-sprig](https://github.com/go-task/slim-sprig) instead of [sprig](https://github.com/Masterminds/sprig), which allowed a file size reduction of about 22% (#219). -- We now use some colors on Task output to better distinguish message types - commands are green, errors are red, etc (#207). - -## v2.8.1 - 2020-05-20 - -- Fix error code for the `--help` flag (#300, #330). -- Print version to stdout instead of stderr (#299, #329). -- Supress `context` errors when using the `--watch` flag (#313, #317). -- Support templating on description (#276, #283). - -## v2.8.0 - 2019-12-07 - -- Add `--parallel` flag (alias `-p`) to run tasks given by the command line in parallel (#266). -- Fixed bug where calling the `task` CLI only informing global vars would not execute the `default` task. -- Add hability to silent all tasks by adding `silent: true` a the root of the Taskfile. - -## v2.7.1 - 2019-11-10 - -- Fix error being raised when `exit 0` was called (#251). - -## v2.7.0 - 2019-09-22 - -- Fixed panic bug when assigning a global variable (#229, #243). -- A task with `method: checksum` will now re-run if generated files are deleted (#228, #238). - -## v2.6.0 - 2019-07-21 - -- Fixed some bugs regarding minor version checks on `version:`. -- Add `preconditions:` to task (#205). -- Create directory informed on `dir:` if it doesn't exist (#209, #211). -- We now have a `--taskfile` flag (alias `-t`), which can be used to run another Taskfile (other than the default `Taskfile.yml`) (#221). -- It's now possible to install Task using Homebrew on Linux ([go-task/homebrew-tap#1](https://github.com/go-task/homebrew-tap/pull/1)). - -## v2.5.2 - 2019-05-11 - -- Reverted YAML upgrade due issues with CRLF on Windows (#201, [go-yaml/yaml#450](https://github.com/go-yaml/yaml/issues/450)). -- Allow setting global variables through the CLI (#192). - -## 2.5.1 - 2019-04-27 - -- Fixed some issues with interactive command line tools, where sometimes the output were not being shown, and similar issues (#114, #190, #200). -- Upgraded [go-yaml/yaml](https://github.com/go-yaml/yaml) from v2 to v3. - -## v2.5.0 - 2019-03-16 - -- We moved from the taskfile.org domain to the new fancy taskfile.dev domain. While stuff is being redirected, we strongly recommend to everyone that use [this install script](https://taskfile.dev/#/installation?id=install-script) to use the new taskfile.dev domain on scripts from now on. -- Fixed to the ZSH completion (#182). -- Add [`--summary` flag along with `summary:` task attribute](https://taskfile.org/#/usage?id=display-summary-of-task) (#180). - -## v2.4.0 - 2019-02-21 - -- Allow calling a task of the root Taskfile from an included Taskfile by prefixing it with `:` (#161, #172). -- Add flag to override the `output` option (#173). -- Fix bug where Task was persisting the new checksum on the disk when the Dry Mode is enabled (#166). -- Fix file timestamp issue when the file name has spaces (#176). -- Mitigating path expanding issues on Windows (#170). - -## v2.3.0 - 2019-01-02 - -- On Windows, Task can now be installed using [Scoop](https://scoop.sh/) (#152). -- Fixed issue with file/directory globing (#153). -- Added ability to globally set environment variables (#138, #159). - -## v2.2.1 - 2018-12-09 - -- This repository now uses Go Modules (#143). We'll still keep the `vendor` directory in sync for some time, though; -- Fixing a bug when the Taskfile has no tasks but includes another Taskfile (#150); -- Fix a bug when calling another task or a dependency in an included Taskfile (#151). - -## v2.2.0 - 2018-10-25 - -- Added support for [including other Taskfiles](https://taskfile.org/#/usage?id=including-other-taskfiles) (#98) - - This should be considered experimental. For now, only including local files is supported, but support for including remote Taskfiles is being discussed. If you have any feedback, please comment on #98. -- Task now have a dedicated documentation site: https://taskfile.org - - Thanks to [Docsify](https://docsify.js.org/) for making this pretty easy. To check the source code, just take a look at the [docs](https://github.com/go-task/task/tree/main/docs) directory of this repository. Contributions to the documentation is really appreciated. - -## v2.1.1 - 2018-09-17 - -- Fix suggestion to use `task --init` not being shown anymore (when a `Taskfile.yml` is not found) -- Fix error when using checksum method and no file exists for a source glob (#131) -- Fix signal handling when the `--watch` flag is given (#132) - -## v2.1.0 - 2018-08-19 - -- Add a `ignore_error` option to task and command (#123) -- Add a dry run mode (`--dry` flag) (#126) - -## v2.0.3 - 2018-06-24 - -- Expand environment variables on "dir", "sources" and "generates" (#116) -- Fix YAML merging syntax (#112) -- Add ZSH completion (#111) -- Implement new `output` option. Please check out the [documentation](https://github.com/go-task/task#output-syntax) - -## v2.0.2 - 2018-05-01 - -- Fix merging of YAML anchors (#112) - -## v2.0.1 - 2018-03-11 - -- Fixes panic on `task --list` - -## v2.0.0 - 2018-03-08 - -Version 2.0.0 is here, with a new Taskfile format. - -Please, make sure to read the [Taskfile versions](https://github.com/go-task/task/blob/main/TASKFILE_VERSIONS.md) document, since it describes in depth what changed for this version. - -- New Taskfile version 2 (#77) -- Possibility to have global variables in the `Taskfile.yml` instead of `Taskvars.yml` (#66) -- Small improvements and fixes - -## v1.4.4 - 2017-11-19 - -- Handle SIGINT and SIGTERM (#75); -- List: print message with there's no task with description; -- Expand home dir ("~" symbol) on paths (#74); -- Add Snap as an installation method; -- Move examples to its own repo; -- Watch: also walk on tasks called on on "cmds", and not only on "deps"; -- Print logs to stderr instead of stdout (#68); -- Remove deprecated `set` keyword; -- Add checksum based status check, alternative to timestamp based. - -## v1.4.3 - 2017-09-07 - -- Allow assigning variables to tasks at run time via CLI (#33) -- Added suport for multiline variables from sh (#64) -- Fixes env: remove square braces and evaluate shell (#62) -- Watch: change watch library and few fixes and improvements -- When use watching, cancel and restart long running process on file change (#59 and #60) - -## v1.4.2 - 2017-07-30 - -- Flag to set directory of execution -- Always echo command if is verbose mode -- Add silent mode to disable echoing of commands -- Fixes and improvements of variables (#56) - -## v1.4.1 - 2017-07-15 - -- Allow use of YAML for dynamic variables instead of $ prefix - - `VAR: {sh: echo Hello}` instead of `VAR: $echo Hello` -- Add `--list` (or `-l`) flag to print existing tasks -- OS specific Taskvars file (e.g. `Taskvars_windows.yml`, `Taskvars_linux.yml`, etc) -- Consider task up-to-date on equal timestamps (#49) -- Allow absolute path in generates section (#48) -- Bugfix: allow templating when calling deps (#42) -- Fix panic for invalid task in cyclic dep detection -- Better error output for dynamic variables in Taskvars.yml (#41) -- Allow template evaluation in parameters - -## v1.4.0 - 2017-07-06 - -- Cache dynamic variables -- Add verbose mode (`-v` flag) -- Support to task parameters (overriding vars) (#31) (#32) -- Print command, also when "set:" is specified (#35) -- Improve task command help text (#35) - -## v1.3.1 - 2017-06-14 - -- Fix glob not working on commands (#28) -- Add ExeExt template function -- Add `--init` flag to create a new Taskfile -- Add status option to prevent task from running (#27) -- Allow interpolation on `generates` and `sources` attributes (#26) - -## v1.3.0 - 2017-04-24 - -- Migrate from os/exec.Cmd to a native Go sh/bash interpreter - - This is a potentially breaking change if you use Windows. - - Now, `cmd` is not used anymore on Windows. Always use Bash-like syntax for your commands, even on Windows. -- Add "ToSlash" and "FromSlash" to template functions -- Use functions defined on github.com/Masterminds/sprig -- Do not redirect stdin while running variables commands -- Using `context` and `errgroup` packages (this will make other tasks to be cancelled, if one returned an error) - -## v1.2.0 - 2017-04-02 - -- More tests and Travis integration -- Watch a task (experimental) -- Possibility to call another task -- Fix "=" not being reconized in variables/environment variables -- Tasks can now have a description, and help will print them (#10) -- Task dependencies now run concurrently -- Support for a default task (#16) - -## v1.1.0 - 2017-03-08 - -- Support for YAML, TOML and JSON (#1) -- Support running command in another directory (#4) -- `--force` or `-f` flag to force execution of task even when it's up-to-date -- Detection of cyclic dependencies (#5) -- Support for variables (#6, #9, #14) -- Operation System specific commands and variables (#13) - -## v1.0.0 - 2017-02-28 - -- Add LICENSE file diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/community.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/community.md deleted file mode 100644 index 6caa4ac9..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/community.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -slug: /community/ -sidebar_position: 9 ---- - -# 社区 - -一些改善 Task 生态的工作是由社区完成，包括安装方法或代码编辑器集成。 我（指作者）非常感谢所有帮助提升整体体验的人们。 - -## 翻译 - -We use [Crowdin](https://crowdin.com/project/taskfile) to translate our document. - -## 集成 - -我们的许多集成都是由社区贡献和维护的。 您可以在 [此处](/integrations#社区集成) 查看社区集成的完整列表。 - -## 安装方法 - -有些安装方式是通过第三方维护的： - -- [GitHub Actions](https://github.com/arduino/setup-task) by @arduino -- [AUR](https://aur.archlinux.org/packages/go-task-bin) by @carlsmedstad -- [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/task.json) -- [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) -- [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/go-task/default.nix) -- [Conda](https://github.com/conda-forge/go-task-feedstock/) - -## 更多 - -同时，感谢所有 [代码贡献者](https://github.com/go-task/task/graphs/contributors)， [资金赞助](https://opencollective.com/task)，以及 [提交问题](https://github.com/go-task/task/issues?q=is%3Aissue) 和 [解答问题](https://github.com/go-task/task/discussions) 的人。 - -如果你发现文档有哪些遗漏信息，欢迎提交 PR。 diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/contributing.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/contributing.md deleted file mode 100644 index 90139377..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/contributing.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -slug: /contributing/ -sidebar_position: 11 ---- - -# 贡献 - -非常欢迎对 Task 的贡献，但我们要求您在提交 PR 之前阅读本文档。 - -:::note - -本文档适用于 [Task][task] 核心存储库 _和_ [Task for Visual Studio Code][vscode-task]。 - -::: - -## 开始之前 - -- **检查已有工作** - 是否已经存在 PR？ 是否存在 Issue 正在讨论您要进行的功能/更改？ 请确保你的工作中确实考虑了这些相关的讨论内容。 -- **向后兼容** - 你的变更是否破坏了已经存在的 Taskfile？ 向后兼容的变更会更容易被合并进去。 您是否可以采取一种方法来保持这种兼容性？ 如果没有，请考虑先提出一个 Issue，以便在您投入时间进行 PR 之前讨论 API 的更改。 -- **Experiments** - If there is no way to make your change backward compatible then there is a procedure to introduce breaking changes into minor versions. We call these "\[experiments\]\[experiments\]". If you're intending to work on an experiment, then please read the \[experiments workflow\]\[experiments-workflow\] document carefully and submit a proposal first. - -## 1. 设置 - -- **Go** - Task 使用 [Go][go] 编写。 我们始终支持最新的两个主要 Go 版本，因此请确保您的版本足够新。 -- **Node.js** - [Node.js][nodejs] 用于托管 Task 的文档服务器，如果您想在本地运行此服务器，则需要它。 如果您想为 Visual Studio Code 扩展做贡献，也需要它。 -- **Yarn** - [Yarn][yarn] 是 Task 使用的 Node.js 包管理器。 - -## 2. 进行变更 - -- **代码风格** - 尽量保持现有的代码风格。 Go 代码应该由 [`gofumpt`][gofumpt] 格式化并使用 [`golangci-lint`][golangci-lint] 进行检查。 任何 Markdown 或 TypeScript 文件都应该由 [Prettier][prettier] 格式化和检查。 这种风格由我们的 CI 强制执行，以确保我们在整个项目中拥有一致的风格。 您可以使用 `task lint` 命令在本地检查代码，并使用 `task lint:fix` 命令自动修复发现的任何问题。 -- **文档** - 确保添加/更新了相关文档。 请参阅下面的 [更新文档](#更新文档) 部分。 -- **测试** - 确保添加/更新了相关测试，并且在提交 PR 前已通过所有测试。 请参阅下面的 [编写测试](#编写测试) 部分。 - -### 运行您的变更 - -要运行带有工作变更的任务，您可以使用 `go run ./cmd/task`。 要针对 `testdata` 中的测试任务文件运行任务的开发构建，您可以使用 `go -run ./cmd/task --dir ./testdata/ `。 - -要运行 Task for Visual Studio Code，您可以在 VSCode 中打开项目并按 F5（或任何您设置绑定的调试键）。 这将打开一个新的 VSCode 窗口，扩展正在运行。 建议以这种方式进行调试，因为它允许您设置断点并单步执行代码。 或者，您可以运行 `task package`，这将生成一个可用于手动安装扩展的 `.vsix` 文件。 - -### 更新文档 - -Task 使用 [Docusaurus][docusaurus] 来托管文档服务器。 此代码位于 Task 核心存储库中。 这可以通过使用 `task docs`（需要 `nodejs` 和 `yarn`）在本地设置和运行。 所有内容均使用 Markdown 编写，位于 `docs/docs` 目录中。 所有 Markdown 文档都应有 80 个字符的换行限制（由 Prettier 强制执行）。 - -When making a change, consider whether a change to the [Usage Guide](/usage) is necessary. This document contains descriptions and examples of how to use Task features. If you're adding a new feature, try to find an appropriate place to add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](/styleguide). - -If you added a new field, command or flag, ensure that you add it to the [API Reference](/api). 还需要将新字段添加到 [JSON Schema][json-schema] 中。 API 参考和 schema 中的字段描述应该匹配。 - -### 编写测试 - -许多 Task 的测试都保存在项目根目录下的 `task_test.go` 文件中，这也是您最有可能想要添加新测试的地方。 大多数这些测试在 `testdata` 目录中也有一个子目录，其中存储了运行测试所需的任何 Taskfiles/数据。 - -进行更改时，请考虑是否需要添加新的测试。 这些测试应确保您添加的功能在未来持续工作。 如果您更改了 Task 的行为，则现有测试也可能需要更新。 - -您还可以考虑为您添加的任何新功能添加单元测试。 单元测试应遵循 Go 约定，即位于与被测试代码相同的包中名为 `*_test.go` 的文件中。 - -## 3. 提交代码 - -尝试编写有意义的提交消息并避免在 PR 上有太多提交。 大多数 PR 应该有一个单一的提交（尽管对于更大的 PR 将它分成几个可能是合理的）。 Git squash(并和) 和 rebase(变基) 是你的好伙伴! - -如果您不确定如何格式化提交消息，请查看 [约定式提交][conventional-commits]。 这种风格不是强制的，但它是使您的提交消息更具可读性和一致性的好方法。 - -## 4. 提交 PR - -- **描述变更** - 确保您提供对更改的全面描述。 -- **Issue/PR 链接** - 链接到之前相关的 Issue 或 PR。 请描述当前工作与之前的不同之处。 -- **示例** - 添加您认为有助于展示更改效果的任何示例或屏幕截图。 -- **PR 草案** - 如果变更还未完成，但您想讨论它们，请将 PR 作为草稿打开并添加评论以开始讨论。 使用评论而不是 PR 描述允许稍后更新描述，同时保留讨论。 - -## 常见问题 - -> 我想贡献，我从哪里开始？ - -查看 [Task][task-open-issues] 或 [Task for Visual Studio Code][vscode-task-open-issues] 的未解决问题列表。 我们有一个 [good first issue][good-first-issue] 标签，用于更简单的问题，非常适合首次贡献。 - -欢迎各种贡献，无论是拼写错误修复还是很小的新功能。 You can also contribute by upvoting/commenting on issues, helping to answer questions or contributing to other [community projects](/community). - -> 我被困住了，我在哪里可以获得帮助？ - -如果您有任何疑问，请随时在我们的 [Discord 服务器][discord-server] 上的 `#help` 论坛频道中提问，或在 GitHub 上打开 [讨论][discussion]。 - ---- - - - - -[task]: https://github.com/go-task/task -[vscode-task]: https://github.com/go-task/vscode-task -[go]: https://go.dev -[gofumpt]: https://github.com/mvdan/gofumpt -[golangci-lint]: https://golangci-lint.run -[prettier]: https://prettier.io -[nodejs]: https://nodejs.org/en/ -[yarn]: https://yarnpkg.com/ -[docusaurus]: https://docusaurus.io -[json-schema]: https://github.com/go-task/task/blob/main/docs/static/schema.json -[task-open-issues]: https://github.com/go-task/task/issues -[vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues -[good-first-issue]: https://github.com/go-task/task/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 -[discord-server]: https://discord.gg/6TY36E39UK -[discussion]: https://github.com/go-task/task/discussions -[conventional-commits]: https://www.conventionalcommits.org diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deprecations/deprecations.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deprecations/deprecations.md deleted file mode 100644 index 965b26d1..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deprecations/deprecations.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: /deprecations/ -sidebar_position: 7 ---- - -# Deprecations - -As Task evolves, it occasionally outgrows some of its functionality. This can be because they are no longer useful, because another feature has replaced it or because of a change in the way that Task works internally. - -When this happens, we mark the functionality as deprecated. This means that it will be removed in a future version of Task. This functionality will continue to work until that time, but we strongly recommend that you do not implement this functionality in new Taskfiles and make a plan to migrate away from it as soon as possible. - -You can view a full list of active deprecations in the "Deprecations" section of the sidebar. diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deprecations/template.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deprecations/template.md deleted file mode 100644 index 646e45c6..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deprecations/template.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Deprecated Feature\} (#\{Issue\}) - -:::warning - -This deprecation breaks the following functionality: - -- \{list any existing functionality that will be broken by this deprecation\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -\{Short description of the feature/behavior and why it is being deprecated\} - -\{Short explanation of any replacement features/behaviors and how users should migrate to it\} diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md deleted file mode 100644 index c45fb65d..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deprecations/version_2_schema.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -slug: /deprecations/version-2-schema/ ---- - -# Version 2 Schema (#1197) - -:::warning - -This deprecation breaks the following functionality: - -- Any Taskfiles that use the version 2 schema -- `Taskvar.yml` files - -::: - -The Taskfile version 2 schema was introduced in March 2018 and replaced by version 3 in August 2019. In May 2023 [we published a deprecation notice][deprecation-notice] for the version 2 schema on the basis that the vast majority of users had already upgraded to version 3 and removing support for version 2 would allow us to tidy up the codebase and focus on new functionality instead. - -In December 2023, the final version of Task that supports the version 2 schema ([v3.33.0][v3.33.0]) was published and all legacy code was removed from Task's main branch. To use a more recent version of Task, you will need to ensure that your Taskfile uses the version 3 schema instead. A list of changes between version 2 and version 3 are available in the [Task v3 Release Notes][v3.0.0]. - - - - -[v3.0.0]: https://github.com/go-task/task/releases/tag/v3.0.0 -[v3.33.0]: https://github.com/go-task/task/releases/tag/v3.33.0 -[deprecation-notice]: https://github.com/go-task/task/issues/1197 diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/donate.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/donate.md deleted file mode 100644 index 7f20328a..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/donate.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: /donate/ -sidebar_position: 16 ---- - -# 赞助 - -如果您觉得这个项目有用，您可以考虑使用下面列出的渠道之一进行捐赠。 - -这只是一种表达“感谢”的方式，它不会给你任何好处，比如在 Issue 上的更高优先级或类似的东西。 - -每月捐赠至少 50 美元的公司将在网站主页和 GitHub 存储库 README 中被标为“金牌赞助商”。 请与 [@andreynering][] 联系，说明你希望显示的标志。 不过，可疑的企业（赌博、赌场等）将不被允许。 - -## GitHub Sponsors - -捐赠给维护者的首选方式是通过 GitHub Sponsors。 Just use the following links to do your donation. We suggest a 50/50 split to each maintainer of the total amount you plan to donate to the project. - -- [@andreynering](https://github.com/sponsors/andreynering) -- [@pd93](https://github.com/sponsors/pd93) - -## Open Collective - -如果你喜欢 [Open Collective](https://opencollective.com/task)，你可以通过这些链接进行捐赠： - -- [每月 2 美元](https://opencollective.com/task/contribute/backer-4034/checkout) -- [每月 5 美元](https://opencollective.com/task/contribute/supporter-8404/checkout) -- [每月 20 美元](https://opencollective.com/task/contribute/sponsor-4035/checkout) -- [每月 50 美元](https://opencollective.com/task/contribute/sponsor-28775/checkout) -- [自定义金额 - 支持一次性捐赠选项](https://opencollective.com/task/donate) - -## PayPal - -你也可以通过 PayPal 向 [@andreynering][] 捐款。 - -- [任何金额 - 一次性捐款](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GSVDU63RKG45A¤cy_code=USD&source=url) - -## PIX (仅巴西) - -如果你是巴西人，你也可以通过 PIX [使用这个QR码](/img/pix.png) 向 [@andreynering][] 捐款。 - - - - -[@andreynering]: https://github.com/andreynering diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/any_variables.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/any_variables.md deleted file mode 100644 index cf2521c7..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/any_variables.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables (#1415) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any -time_. We strongly recommend that you do not use these features in a production -environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- Dynamically defined variables (using the `sh` keyword) - -::: - -:::info - -To enable this experiment, set the environment variable: -`TASK_X_ANY_VARIABLES=1`. Check out [our guide to enabling experiments -][enabling-experiments] for more information. - -::: - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the [slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for "collection-type" variables, the `for` -keyword has been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -This also works for maps. When looping over a map we also make an additional -`{{.KEY}}` variable availabe that holds the string value of the map key. -Remember that maps are unordered, so the order in which the items are looped -over is random: - -```yaml -version: 3 - -tasks: - foo: - vars: - MAP: - KEY_1: - SUBKEY: sub_value_1 - KEY_2: - SUBKEY: sub_value_2 - KEY_3: - SUBKEY: sub_value_3 - cmds: - - for: - var: MAP - cmd: echo {{.KEY}} {{.ITEM.SUBKEY}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[enabling-experiments]: /experiments/#enabling-experiments - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx deleted file mode 100644 index 73cdcd80..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/any_variables.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -slug: /experiments/any-variables/ ---- - -# Any Variables - -- Issue: #1415 -- Environment variable: `TASK_X_ANY_VARIABLES=1` -- Breaks: - - Dynamically defined variables (using the `sh` keyword) - -Currently, Task only supports string variables. This experiment allows you to -specify and use the following variable types: - -- `string` -- `bool` -- `int` -- `float` -- `array` -- `map` - -This allows you to have a lot more flexibility in how you use variables in -Task's templating engine. For example: - -Evaluating booleans: - -```yaml -version: 3 - -tasks: - foo: - vars: - BOOL: false - cmds: - - '{{if .BOOL}}echo foo{{end}}' -``` - -Arithmetic: - -```yaml -version: 3 - -tasks: - foo: - vars: - INT: 10 - FLOAT: 3.14159 - cmds: - - 'echo {{add .INT .FLOAT}}' -``` - -Ranging: - -```yaml -version: 3 - -tasks: - foo: - vars: - ARRAY: [1, 2, 3] - cmds: - - 'echo {{range .ARRAY}}{{.}}{{end}}' -``` - -There are many more templating functions which can be used with the new types of -variables. For a full list, see the -[slim-sprig][slim-sprig] documentation. - -## Looping over variables - -Previously, you would have to use a delimiter separated string to loop over an -arbitrary list of items in a variable and split them by using the `split` subkey -to specify the delimiter: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: 'foo,bar,baz' - cmds: - - for: - var: LIST - split: ',' - cmd: echo {{.ITEM}} -``` - -Because this experiment adds support for array variables, the `for` keyword has -been updated to support looping over arrays directly: - -```yaml -version: 3 - -tasks: - foo: - vars: - LIST: [foo, bar, baz] - cmds: - - for: - var: LIST - cmd: echo {{.ITEM}} -``` - -String splitting is still supported and remember that for simple cases, you have -always been able to loop over an array without using variables at all: - -```yaml -version: 3 - -tasks: - foo: - cmds: - - for: [foo, bar, baz] - cmd: echo {{.ITEM}} -``` - -## Migration - -Taskfiles with dynamically defined variables via the `sh` subkey will no longer -work with this experiment enabled. In order to keep using dynamically defined -variables, you will need to migrate your Taskfile to use the new syntax. - -Previously, you might have defined a dynamic variable like this: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: - sh: 'echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -With this experiment enabled, you will need to remove the `sh` subkey and define -your command as a string that begins with a `$`. This will instruct Task to -interpret the string as a command instead of a literal value and the variable -will be populated with the output of the command. For example: - -```yaml -version: 3 - -task: - foo: - vars: - CALCULATED_VAR: '$echo hello' - cmds: - - 'echo {{.CALCULATED_VAR}}' -``` - -If your current Taskfile contains a string variable that begins with a `$`, you -will now need to escape the `$` with a backslash (`\`) to stop Task from -executing it as a command. - - - -[slim-sprig]: https://go-task.github.io/slim-sprig/ - - diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/experiments.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/experiments.md deleted file mode 100644 index b1a70473..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/experiments.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -slug: /experiments/ -sidebar_position: 6 ---- - -# Experiments - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -In order to allow Task to evolve quickly, we roll out breaking changes to minor versions behind experimental flags. This allows us to gather feedback on breaking changes before committing to a major release. This document describes the current set of experimental features and their status in the [workflow](#workflow). - -You can view a full list of active experiments in the "Experiments" section of the sidebar. - -## Enabling Experiments - -You can enable an experimental feature by doing one of the following: - -1. Using the relevant environment variable in front of a task command. For example, `TASK_X_{FEATURE}=1 task {my-task}`. This is intended for one-off invocations of Task to test out experimental features. -1. Using the relevant environment variable in your "dotfiles" (e.g. `.bashrc`, `.zshrc` etc.). This is intended for permanently enabling experimental features in your environment. -1. Creating a `.env` file in the same directory as your root Taskfile that contains the relevant environment variables. This allows you to enable an experimental feature at a project level. For example: - -```shell title=".env" -TASK_X_FEATURE=1 -``` - -## Current Experimental Features and Deprecations - -Each section below details an experiment or deprecation and explains what the flags/environment variables to enable the experiment are and how the feature's behavior will change. It will also explain what you need to do to migrate any existing Taskfiles to the new behavior. - -## Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -### 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -### 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -### 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -### 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -### 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -### Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/gentle_force.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/gentle_force.md deleted file mode 100644 index 514602bb..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/gentle_force.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -slug: /experiments/gentle-force/ ---- - -# Gentle Force (#1200) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- The `--force` flag - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_FORCE=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -The `--force` flag currently forces _all_ tasks to run regardless of the status checks. This can be useful, but we have found that most of the time users only expect the direct task they are calling to be forced and _not_ all of its dependant tasks. - -This experiment changes the `--force` flag to only force the directly called task. All dependant tasks will have their statuses checked as normal and will only run if Task considers them to be out of date. A new `--force-all` flag will also be added to maintain the current behavior for users that need this functionality. - -If you want to migrate, but continue to force all dependant tasks to run, you should replace all uses of the `--force` flag with `--force-all`. Alternatively, if you want to adopt the new behavior, you can continue to use the `--force` flag as you do now! - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md deleted file mode 100644 index 73a934d8..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/remote_taskfiles.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -slug: /experiments/remote-taskfiles/ ---- - -# Remote Taskfiles (#1317) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_REMOTE_TASKFILES=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -This experiment allows you to specify a remote Taskfile URL when including a Taskfile. For example: - -```yaml -version: '3' - -includes: - my-remote-namespace: https://raw.githubusercontent.com/my-org/my-repo/main/Taskfile.yml -``` - -This works exactly the same way that including a local file does. Any tasks in the remote Taskfile will be available to run from your main Taskfile via the namespace `my-remote-namespace`. For example, if the remote file contains the following: - -```yaml -version: '3' - -tasks: - hello: - silent: true - cmds: - - echo "Hello from the remote Taskfile!" -``` - -and you run `task my-remote-namespace:hello`, it will print the text: "Hello from the remote Taskfile!" to your console. - -## Security - -Running commands from sources that you do not control is always a potential security risk. For this reason, we have added some checks when using remote Taskfiles: - -1. When running a task from a remote Taskfile for the first time, Task will print a warning to the console asking you to check that you are sure that you trust the source of the Taskfile. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the remote Taskfile will run and further calls to the remote Taskfile will not prompt you again. -2. Whenever you run a remote Taskfile, Task will create and store a checksum of the file that you are running. If the checksum changes, then Task will print another warning to the console to inform you that the contents of the remote file has changed. If you do not accept the prompt, then Task will exit with code `104` (not trusted) and nothing will run. If you accept the prompt, the checksum will be updated and the remote Taskfile will run. - -Sometimes you need to run Task in an environment that does not have an interactive terminal, so you are not able to accept a prompt. In these cases you are able to tell task to accept these prompts automatically by using the `--yes` flag. Before enabling this flag, you should: - -1. Be sure that you trust the source and contents of the remote Taskfile. -2. Consider using a pinned version of the remote Taskfile (e.g. A link containing a commit hash) to prevent Task from automatically accepting a prompt that says a remote Taskfile has changed. - -Task currently supports both `http` and `https` URLs. However, the `http` requests will not execute by default unless you run the task with the `--insecure` flag. This is to protect you from accidentally running a remote Taskfile that is hosted on and unencrypted connection. Sources that are not protected by TLS are vulnerable to [man-in-the-middle attacks][man-in-the-middle-attacks] and should be avoided unless you know what you are doing. - -## Caching & Running Offline - -Whenever you run a remote Taskfile, the latest copy will be downloaded from the internet and cached locally. If for whatever reason, you lose access to the internet, you will still be able to run your tasks by specifying the `--offline` flag. This will tell Task to use the latest cached version of the file instead of trying to download it. You are able to use the `--download` flag to update the cached version of the remote files without running any tasks. - -By default, Task will timeout requests to download remote files after 10 seconds and look for a cached copy instead. This timeout can be configured by setting the `--timeout` flag and specifying a duration. For example, `--timeout 5s` will set the timeout to 5 seconds. - - - - -[enabling-experiments]: /experiments/#enabling-experiments -[man-in-the-middle-attacks]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/template.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/template.md deleted file mode 100644 index 59246cf5..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/template.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -#This is a template for an experiments documentation -#Copy this page and fill in the details as necessary -title: '--- Template ---' -sidebar_position: -1 #Always push to the top -draft: true #Hide in production ---- - -# \{Name of Experiment\} (#\{Issue\}) - -:::caution - -All experimental features are subject to breaking changes and/or removal _at any time_. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only. - -::: - -:::warning - -This experiment breaks the following functionality: - -- \{list any existing functionality that will be broken by this experiment\} -- \{if there are no breaking changes, remove this admonition\} - -::: - -:::info - -To enable this experiment, set the environment variable: `TASK_X_{feature}=1`. Check out [our guide to enabling experiments ][enabling-experiments] for more information. - -::: - -\{Short description of the feature\} - -\{Short explanation of how users should migrate to the new behavior\} - - - - -[enabling-experiments]: /experiments/#enabling-experiments diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/workflow.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/workflow.md deleted file mode 100644 index 62aff616..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/experiments/workflow.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -slug: /experiments/workflow/ ---- - -# Workflow - -Experiments are a way for us to test out new features in Task before committing to them in a major release. Because this concept is built around the idea of feedback from our community, we have built a workflow for the process of introducing these changes. This ensures that experiments are given the attention and time that they need and that we are getting the best possible results out of them. - -The sections below describe the various stages that an experiment must go through from its proposal all the way to being released in a major version of Task. - -## 1. Proposal - -All experimental features start with a proposal in the form of a GitHub issue. If the maintainers decide that an issue has enough support and is a breaking change or is complex/controversial enough to require user feedback, then the issue will be marked with the ![proposal][] label. At this point, the issue becomes a proposal and a period of consultation begins. During this period, we request that users provide feedback on the proposal and how it might effect their use of Task. It is up to the discretion of the maintainers to decide how long this period lasts. - -## 2. Draft - -Once a proposal's consultation ends, a contributor may pick up the work and begin the initial implementation. Once a PR is opened, the maintainers will ensure that it meets the requirements for an experimental feature (i.e. flags are in the right format etc) and merge the feature. Once this code is released, the status will be updated via the ![draft][] label. This indicates that an implementation is now available for use in a release and the experiment is open for feedback. - -:::note - -During the draft period, major changes to the implementation may be made based on the feedback received from users. There are _no stability guarantees_ and experimental features may be abandoned _at any time_. - -::: - -## 3. Candidate - -Once an acceptable level of consensus has been reached by the community and feedback/changes are less frequent/significant, the status may be updated via the ![candidate][] label. This indicates that a proposal is _likely_ to accepted and will enter a period for final comments and minor changes. - -## 4. Stable - -Once a suitable amount of time has passed with no changes or feedback, an experiment will be given the ![stable][] label. At this point, the functionality will be treated like any other feature in Task and any changes _must_ be backward compatible. This allows users to migrate to the new functionality without having to worry about anything breaking in future releases. This provides the best experience for users migrating to a new major version. - -## 5. Released - -When making a new major release of Task, all experiments marked as ![stable][] will move to ![released][] and their behaviors will become the new default in Task. Experiments in an earlier stage (i.e. not stable) cannot be released and so will continue to be experiments in the new version. - -## Abandoned / Superseded - -If an experiment is unsuccessful at any point then it will be given the ![abandoned][] or ![superseded][] labels depending on which is more suitable. These experiments will be removed from Task. - - - - -[proposal]: https://img.shields.io/badge/experiment:%20proposal-purple -[draft]: https://img.shields.io/badge/experiment:%20draft-purple -[candidate]: https://img.shields.io/badge/experiment:%20candidate-purple -[stable]: https://img.shields.io/badge/experiment:%20stable-purple -[released]: https://img.shields.io/badge/experiment:%20released-purple -[abandoned]: https://img.shields.io/badge/experiment:%20abandoned-purple -[superseded]: https://img.shields.io/badge/experiment:%20superseded-purple diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/faq.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/faq.md deleted file mode 100644 index b12363fe..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/faq.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -slug: /faq/ -sidebar_position: 15 ---- - -# 常见问题 - -此页面包含有关 Task 的常见问题列表。 - -## 为什么我的 task 不会更新我的 shell 环境？ - -这是 shell 工作方式的限制。 Task 作为当前 shell 的子进程运行，因此它不能更改启动它的 shell 的环境。 其他任务运行器和构建工具也有此限制。 - -解决此问题的一种常见方法是创建一个 task，该任务将生成可由您的 shell 解析的输出。 例如，要在 shell 上设置环境变量，您可以编写如下任务： - -```yaml -my-shell-env: - cmds: - - echo "export FOO=foo" - - echo "export BAR=bar" -``` - -现在运行 `eval $(task my-shell-env)` 变量 `$FOO` 和 `$BAR` 将在您的 shell 中可用。 - -## 我不能在多个命令中重用我的 shell - -Task runs each command as a separate shell process, so something you do in one command won't effect any future commands. 比如： - -```yaml -version: '3' - -tasks: - foo: - cmds: - - a=foo - - echo $a - # outputs "" -``` - -To work around this you can either use a multiline command: - -```yaml -version: '3' - -tasks: - foo: - cmds: - - | - a=foo - echo $a - # outputs "foo" -``` - -对于更复杂的多行命令，建议将您的代码移动到个单独的文件，然后调用对应的脚本文件： - -```yaml -version: '3' - -tasks: - foo: - cmds: - - ./foo-printer.bash -``` - -```bash -#!/bin/bash -a=foo -echo $a -``` - -## 内置的 'x' 命令在 Windows 上不起作用 - -Windows 上的默认 shell（`cmd` 和 `powershell`）没有像 `rm` 和 `cp` 这样的内置命令。 这意味着这些命令将不起作用。 如果你想让你的 Taskfile 完全跨平台，你需要使用以下方法之一来解决这个限制： - -- 使用 `{{OS}}` 函数运行特定于操作系统的脚本。 -- 使用 `{{if eq OS "windows"}}powershell {{end}}` 之类的东西来检测 windows 并直接在 Powershell 中运行命令。 -- 在 Windows 上使用支持这些命令的 shell 作为内置命令，例如 [Git Bash][git-bash] 或 [WSL][wsl]。 - -我们希望对 Task 的这一部分进行改进，下面的 Issue 会跟踪这项工作。 非常欢迎建设性的意见和贡献！ - -- #197 -- [mvdan/sh#93](https://github.com/mvdan/sh/issues/93) -- [mvdan/sh#97](https://github.com/mvdan/sh/issues/97) - - - - -[git-bash]: https://gitforwindows.org/ -[wsl]: https://learn.microsoft.com/en-us/windows/wsl/install diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/installation.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/installation.md deleted file mode 100644 index 91136c6f..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/installation.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -slug: /installation/ -sidebar_position: 2 ---- - -# 安装 - -Task 提供以下多种安装方式。 查看以下可用方法。 - -## 包管理工具 - -### Homebrew - -如果您使用的是 macOS 或 Linux 并安装了 [Homebrew](https://brew.sh/)，获取 Task 就像运行以下命令一样简单： - -```bash -brew install go-task/tap/go-task -``` - -The above Formula is [maintained by ourselves](https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb). - -最近，[官方 Homebrew 存储库](https://formulae.brew.sh/formula/go-task) 中也提供了 Task，因此如果您愿意，也可以使用该选项： - -```bash -brew install go-task -``` - -### Tea - -If you're on macOS or Linux and have [tea][tea] installed, getting Task is as simple as running: - -```bash -tea task -``` - -or, if you have tea’s magic enabled: - -```bash -task -``` -这种安装方式是社区维护的。 After a new release of Task, they are automatically released by tea in a minimum of time. - -### Snap - -Task 在 [Snapcraft][snapcraft] 中可用，但请记住，您的 Linux 发行版应该符合 Snaps 的基本要求才能正确安装： - -```bash -sudo snap install task --classic -``` - -### Chocolatey - -如果 Windows 上安装了 [Chocolatey][choco]，再安装 Task 只要这样： - -```bash -choco install go-task -``` - -这种安装方式是社区维护的。 - -### Scoop - -如果 Windows 上安装了 [Scoop][scoop]，再安装 Task 只要这样： - -```cmd -scoop install task -``` - -This installation method is community owned. 新版 Task 发布后，需要过一段时间才能通过 Scoop 安装。 - -### AUR - -如果你使用的是 Arch Linux，你可以使用你最喜欢的包管理器（例如 `yay`、`pacaur` 或 `yaourt`）从 [AUR](https://aur.archlinux.org/packages/go-task-bin) 安装 Task： - -```cmd -yay -S go-task-bin -``` - -或者，有一个从源代码安装的 [软件包](https://aur.archlinux.org/packages/go-task)，而不是从 [发布页面](https://github.com/go-task/task/releases) 下载二进制文件： - -```cmd -yay -S go-task -``` - -这种安装方式是社区维护的。 - -### Fedora - -如果您使用的是 Fedora Linux，则可以使用 `dnf` 从 [官方 Fedora 存储库](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) 安装 Task： - -```cmd -sudo dnf install go-task -``` - -这种安装方式是社区维护的。 新版 Task 发布后，需要一段时间才能通过 [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) 安装。 - -### Nix - -如果您使用的是 NixOS 或安装了 Nix，则可以从 [nixpkgs](https://github.com/NixOS/nixpkgs) 安装 Task： - -```cmd -nix-env -iA nixpkgs.go-task -``` - -这种安装方式是社区维护的。 新版本的 Task 发布后，可能需要一些时间才能在 [nixpkgs](https://github.com/NixOS/nixpkgs) 中可用。 - -### npm - -您也可以通过使用 Node 和 npm 安装 [此包](https://www.npmjs.com/package/@go-task/cli) 来安装 Task。 - -```bash -npm install -g @go-task/cli -``` - -### Winget - -如果您正在使用 Windows 并且安装了 [winget](https://github.com/microsoft/winget-cli) 软件包管理工具，您可以从 [winget-pkgs](https://github.com/microsoft/winget-pkgs) 安装 Task。 - -```bash -winget install Task.Task -``` - -## 获取二进制文件 - -### 二进制文件 - -您可以从 [GitHub 上的发布页面][releases] 下载二进制文件并添加到您的 `$PATH` 中。 - -还支持 DEB 和 RPM 包。 - -`task_checksums.txt` 文件包含每个文件的 SHA-256 checksum。 - -### 安装脚本 - -我们还有一个 [安装脚本][installscript]，它在 CI 等场景中非常有用。 非常感谢 [GoDownloader](https://github.com/goreleaser/godownloader) 使这个脚本的生成变得容易。 - -默认情况下，它安装在相对于工作目录的 `./bin` 目录中： - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -``` - -可以使用 `-b` 参数覆盖安装目录。 通过 `-b` 参数可以自定义安装目录，在 Linux 中当前用户安装一般会选择 `~/.local/bin` 或 `~/bin`， 全局用户安装会选择 `/usr/local/bin`： - -```bash -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin -``` - -:::caution - -在 macOS 和 Windows 上，`~/.local/bin` 和 `~/bin` 默认情况下不会添加到 `$PATH`。 - -::: - -### GitHub Actions - -如果你想在 GitHub Actions 中安装 Task，你可以尝试使用 Arduino 团队的 [这个 action](https://github.com/arduino/setup-task)： - -```yaml -- name: Install Task - uses: arduino/setup-task@v1 - with: - version: 3.x - repo-token: ${{ secrets.GITHUB_TOKEN }} -``` - -This installation method is community owned. - -## 从源码构建 - -### Go Modules - -确保您已正确安装和设置受支持的 [Go][go] 版本。 您可以在 [go.mod](https://github.com/go-task/task/blob/main/go.mod#L3) 文件中找到最低要求的 Go 版本。 - -然后，您可以通过运行以下命令全局安装最新版本： - -```bash -go install github.com/go-task/task/v3/cmd/task@latest -``` - -或者你可以安装到另一个目录： - -```bash -env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest -``` - -:::tip - -对于 CI 环境，我们建议改用 [安装脚本](#安装脚本)，它更快更稳定，因为它只会下载最新发布的二进制文件。 - -::: - -## 自动完成 - -下载与您的 shell 对应的自动完成文件。 - -[所有自动完成都在 Task 存储库中可用](https://github.com/go-task/task/tree/main/completion)。 - -### Bash - -首先，确认你通过包管理安装了 bash-completion。 - -使完成文件可执行： - -``` -chmod +x path/to/task.bash -``` - -然后在 `~/.bash_profile` 文件中添加： - -```shell -source path/to/task.bash -``` - -### ZSH - -把 `_task` 文件放到你的 `$FPATH` 中： - -```shell -mv path/to/_task /usr/local/share/zsh/site-functions/_task -``` - -在 `~/.zshrc` 文件中添加： - -```shell -autoload -U compinit -compinit -i -``` - -建议使用 ZSH 5.7 或更高版本。 - -### Fish - -移动 `task.fish` 完成脚本： - -```shell -mv path/to/task.fish ~/.config/fish/completions/task.fish -``` - -### PowerShell - -使用以下命令打开您的配置文件脚本： - -``` -mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue -notepad $profile -``` - -添加这行并保存文件： - -```shell -Invoke-Expression -Command path/to/task.ps1 -``` - - - - -[go]: https://golang.org/ -[snapcraft]: https://snapcraft.io/task -[installscript]: https://github.com/go-task/task/blob/main/install-task.sh -[releases]: https://github.com/go-task/task/releases -[choco]: https://chocolatey.org/ -[scoop]: https://scoop.sh/ -[tea]: https://tea.xyz/ diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/integrations.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/integrations.md deleted file mode 100644 index d505783a..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/integrations.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -slug: /integrations/ -sidebar_position: 8 ---- - -# 集成 - -## Visual Studio Code 扩展 - -Task 有一个 [针对 Visual Studio Code 的官方扩展](https://marketplace.visualstudio.com/items?itemName=task.vscode-task)。 这个项目的代码可以在 [这里](https://github.com/go-task/vscode-task) 找到。 要使用此扩展，您的系统上必须安装 Task v3.23.0+。 - -此扩展提供以下功能（以及更多）： - -- 在侧边栏中查看 task。 -- 从侧边栏和命令面板运行 task。 -- 从侧边栏和命令面板转到定义。 -- 运行上一个 task 命令。 -- 多根工作区支持。 -- 在当前工作空间中初始化一个 Taskfile。 - -要获得 Taskfile 的自动完成和验证，请参阅下面的 [Schema](#schema) 部分。 - -![Task for Visual Studio Code](https://github.com/go-task/vscode-task/blob/main/res/preview.png?raw=true) - -## Schema - -This was initially created by @KROSF in [this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and is now officially maintained in [this file](https://github.com/go-task/task/blob/main/docs/static/schema.json) and made available at https://taskfile.dev/schema.json. 这个 schema 可用于验证 Taskfile 并在许多代码编辑器中提供自动完成功能： - -### Visual Studio Code - -要将 schema 集成到 VS Code 中，您需要安装 Red Hat 的 [YAML 扩展](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)。 项目中的任何 `Taskfile.yml` 都应该被自动检测到，并且验证/自动完成应该可以工作。 如果这不起作用或者您想为具有不同名称的文件手动配置它，您可以将以下内容添加到您的 `settings.json`： - -```json -// settings.json -{ - "yaml.schemas": { - "https://taskfile.dev/schema.json": [ - "**/Taskfile.yml", - "./path/to/any/other/taskfile.yml" - ] - } -} -``` - -您还可以通过将以下注释添加到文件顶部来直接在 Taskfile 中配置 schema： - -```yaml -# yaml-language-server: $schema=https://taskfile.dev/schema.json -version: '3' -``` - -您可以在 [YAML 语言服务器项目](https://github.com/redhat-developer/yaml-language-server) 中找到更多相关信息。 - -## 社区集成 - -除了我们的官方集成之外，还有一个很棒的开发人员社区，他们为 Task 创建了自己的集成： - -- [Sublime Text Plugin](https://packagecontrol.io/packages/Taskfile) [[source](https://github.com/biozz/sublime-taskfile)] by @biozz -- [IntelliJ Plugin](https://plugins.jetbrains.com/plugin/17058-taskfile) [[source](https://github.com/lechuckroh/task-intellij-plugin)] by @lechuckroh -- [mk](https://github.com/pycontribs/mk) 命令行工具本机识别 Taskfile。 - -如果你做了一些与 Task 集成的东西，请随意打开一个 PR 将它添加到这个列表中。 diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/intro.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/intro.md deleted file mode 100644 index 8ff55740..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/intro.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: / -sidebar_position: 1 -title: 主页 ---- - -# Task - -
- -
- -Task 是一个任务运行器/构建工具，旨在比 [GNU Make][make] 等更简单易用。 - -由于它是用 [Go](https://go.dev/) 编写的，Task 只是一个二进制文件，没有其他依赖项，这意味着您不需要为了使用构建工具而烦恼任何复杂的安装设置。 - -Once [installed](/installation), you just need to describe your build tasks using a simple [YAML][yaml] schema in a file called `Taskfile.yml`: - -```yaml title="Taskfile.yml" -version: '3' - -tasks: - hello: - cmds: - - echo 'Hello World from Task!' - silent: true -``` - -然后通过从您的终端运行 `task hello` 来调用它。 - -上面的示例只是一个开始，您可以查看 [使用指南](/usage) 以检查完整的规则文档和 Task 功能。 - -## Features - -- [Easy installation](/installation): just download a single binary, add to `$PATH` and you're done! 或者，您也可以根据需要使用 [Homebrew](https://brew.sh/)、[Snapcraft](https://snapcraft.io/) 或 [Scoop](https://scoop.sh/) 进行安装。 -- Available on CIs: by adding [this simple command](/installation#install-script) to install on your CI script and you're ready to use Task as part of your CI pipeline; -- 真正的跨平台：虽然大多数构建工具只能在 Linux 或 macOS 上运行良好，但由于 [这个用于 Go 的 shell 解释器](https://github.com/mvdan/sh)，Task 也支持 Windows。 -- 非常适合代码生成：如果给定的一组文件自上次运行以来没有更改（基于其时间戳或内容），您可以轻松地 [阻止 task 运行](/usage#减少不必要的工作)。 - - - - -[make]: https://www.gnu.org/software/make/ -[yaml]: http://yaml.org/ diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/releasing.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/releasing.md deleted file mode 100644 index 708d6e11..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/releasing.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -slug: /releasing/ -sidebar_position: 13 ---- - -# 发布 - -Task 的发布流程是在 [GoReleaser][goreleaser] 的帮助下完成的。 本地调用 Taskfile 的 `test-release` task 可以测试发布流程。 - -[GitHub Actions](https://github.com/go-task/task/actions) 会在新 tag 推送到 `main` 分支的时候，自动发布产出物（原生的可执行文件、DEB 和 RPM 包）。 - -从 v3.15.0 开始，原始可执行文件也可以通过检查特定的标签并调用 `goreleaser build`，使用上述 GitHub Actions 中定义的 Go 版本，在本地进行复制和验证。 - -# Homebrew - -Goreleaser will automatically push a new commit to the [Formula/go-task.rb][gotaskrb] file in the [Homebrew tap][homebrewtap] repository to release the new version. - -# npm - -要发布到 npm ，请更新 [`package.json`][packagejson] 文件中的版本，然后运行 `task npm:publish` 来推送它。 - -# Snapcraft - -[snap package](https://github.com/go-task/snap) 发布新版本需要手动执行下面步骤： - -- Updating the current version on [snapcraft.yaml][snapcraftyaml]. -- 把新的 `amd64`, `armhf` 和 `arm64` 移动到 [Snapcraft dashboard][snapcraftdashboard] 的稳定通道。 - -# winget - -winget also requires manual steps to be completed. By running `task goreleaser:test` locally, manifest files will be generated on `dist/winget/manifests/t/Task/Task/v{version}`. [Upload the manifest directory into this fork](https://github.com/go-task/winget-pkgs/tree/master/manifests/t/Task/Task) and open a pull request into [this repository](https://github.com/microsoft/winget-pkgs). - -# Scoop - -Scoop 是一个 Windows 系统的命令行包管理工具。 Scoop 的包清单由社区维护。 Scoop 的维护人通常会在 [这个文件](https://github.com/lukesampson/scoop-extras/blob/master/bucket/task.json) 里维护版本。 If you think its Task version is outdated, open an issue to let us know. - -# Nix - -Nix 安装由社区维护。 Nix 包的维护人员通常会在 [这个文件](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/development/tools/go-task/default.nix) 里维护版本。 如果发现 Task 版本是旧的，请提交一个 Issue 通知我们。 - - - - -[goreleaser]: https://goreleaser.com/ -[homebrewtap]: https://github.com/go-task/homebrew-tap -[gotaskrb]: https://github.com/go-task/homebrew-tap/blob/main/Formula/go-task.rb -[packagejson]: https://github.com/go-task/task/blob/main/package.json#L3 -[snapcraftyaml]: https://github.com/go-task/snap/blob/main/snap/snapcraft.yaml#L2 -[snapcraftdashboard]: https://snapcraft.io/task/releases diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/styleguide.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/styleguide.md deleted file mode 100644 index 093d7c82..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/styleguide.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -slug: /styleguide/ -sidebar_position: 10 ---- - -# 风格指南 - -这是对 `Taskfile.yml` 文件的官方风格指南。 本指南包含一些基本说明，可让您的任务文件保持简洁易用。 - -这包含一般准则，但不一定需要严格遵守。 如果你需要或想要，请随时提出不同意见，并在某些时候以不同方式进行。 此外，请随时打开 Issue 或 PR，对本指南进行改进。 - -## 使用正确的关键字顺序 - -- `version:` -- `includes:` -- 可选配置命令，比如 `output:`、`silent:`、`method:` 和 `run:` -- `vars:` -- `env:`、`dotenv:` -- `tasks:` - -## 使用 2 个空格缩进 - -这是 YAML 文件最常见的约定，Task 同样也遵循它。 - -```yaml -# bad -tasks: - foo: - cmds: - - echo 'foo' - - -# good -tasks: - foo: - cmds: - - echo 'foo' -``` - -## 用空行分隔主要部分 - -```yaml -# bad -version: '3' -includes: - docker: ./docker/Taskfile.yml -output: prefixed -vars: - FOO: bar -env: - BAR: baz -tasks: - # ... - - -# good -version: '3' - -includes: - docker: ./docker/Taskfile.yml - -output: prefixed - -vars: - FOO: bar - -env: - BAR: baz - -tasks: - # ... -``` - -## 用空行分隔 task - -```yaml -# bad -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - bar: - cmds: - - echo 'bar' - baz: - cmds: - - echo 'baz' - - -# good -version: '3' - -tasks: - foo: - cmds: - - echo 'foo' - - bar: - cmds: - - echo 'bar' - - baz: - cmds: - - echo 'baz' -``` - -## 使用大写变量名称 - -```yaml -# bad -version: '3' - -vars: - binary_name: myapp - -tasks: - build: - cmds: - - go build -o {{.binary_name}} . - - -# good -version: '3' - -vars: - BINARY_NAME: myapp - -tasks: - build: - cmds: - - go build -o {{.BINARY_NAME}} . -``` - -## 模板中不要用空格包住变量 - -```yaml -# bad -version: '3' - -tasks: - greet: - cmds: - - echo '{{ .MESSAGE }}' - - -# good -version: '3' - -tasks: - greet: - cmds: - - echo '{{.MESSAGE}}' -``` - -这个约定也被大多数人用于 Go 模板。 - -## 用破折号分隔任务名称单词 - -```yaml -# bad -version: '3' - -tasks: - do_something_fancy: - cmds: - - echo 'Do something' - - -# good -version: '3' - -tasks: - do-something-fancy: - cmds: - - echo 'Do something' -``` - -## 使用冒号作为任务命名空间 - -```yaml -# good -version: '3' - -tasks: - docker:build: - cmds: - - docker ... - - docker:run: - cmds: - - docker-compose ... -``` - -这在使用包含的任务文件时也会自动完成。 - -## 优先使用额外的脚本，避免使用复杂的多行命令。 - -```yaml -# bad -version: '3' - -tasks: - build: - cmds: - - | - for i in $(seq 1 10); do - echo $i - echo "some other complex logic" - done' - -# good -version: '3' - -tasks: - build: - cmds: - - ./scripts/my_complex_script.sh -``` diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/taskfile_versions.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/taskfile_versions.md deleted file mode 100644 index d2494b20..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/taskfile_versions.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -slug: /taskfile-versions/ -sidebar_position: 5 ---- - -# Taskfile 版本 - -Taskfile 语法和功能随着时间的推移而改变。 本文档解释了每个版本的变化以及如何升级您的任务文件。 - -## Taskfile 版本的含义 - -Taskfile 版本遵循 Task 版本。 例如， taskfile version `2` 意味着应该切换为 Task `v2.0.0` 以支持它。 - -Taskfile 文件的 `version:` 关键字接受语义化字符串， 所以 `2`, `2.0` 或 `2.0.0` 都可以。 如果使用版本号 `2.0`，那么 Task 就不会使用 `2.1` 的功能， 但如果使用版本号 `2`, 那么任意 `2.x.x` 版本中的功能都是可用的， 但 `3.0.0+` 的功能不可用。 - -## Version 3 ![latest](https://img.shields.io/badge/latest-brightgreen) - -以下是 `v3` 所做的一些主要变更： - -- Task 的日志使用彩色输出 -- 支持类 `.env` 文件 -- 添加 `label:` 设置后可以覆盖任务名称在日志中的显示方式 -- 添加了全局 `method:` 允许设置默认方法，Task 的默认值更改为 `checksum` -- Two magic variables were added when using `status:`: `CHECKSUM` and `TIMESTAMP` which contains, respectively, the XXH3 checksum and greatest modification timestamp of the files listed on `sources:` -- 另外，`TASK` 变量总是可以使用当前的任务名称 -- CLI 变量始终被视为全局变量 -- 向 `includes` 添加了 `dir:` 选项，以允许选择包含的任务文件将在哪个目录上运行： - -```yaml -includes: - docs: - taskfile: ./docs - dir: ./docs -``` - -- 实现短任务语法。 以下所有语法都是等效的： - -```yaml -version: '3' - -tasks: - print: - cmds: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: - - echo "Hello, World!" -``` - -```yaml -version: '3' - -tasks: - print: echo "Hello, World!" -``` - -- 对变量的处理方式进行了重大重构。 现在它们更容易理解了。 `expansions:` 设置被移除了，因为它变得不必要。 这是 Task 处理变量的顺序，每一层都可以看到前一层设置的变量并覆盖这些变量。 - - 环境变量 - - 全局或 CLI 变量 - - 调用变量 - - Task 变量 - -## 版本 2.6 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -2.6 版本增加任务的先决条件字段 `preconditions`。 - -```yaml -version: '2' - -tasks: - upload_environment: - preconditions: - - test -f .env - cmds: - - aws s3 cp .env s3://myenvironment -``` - -Please check the [documentation][includes] - -## 版本 2.2 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -2.2 版带有全局 `includes` 选项来包含其他 Taskfiles： - -```yaml -version: '2' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -## 版本 2.1 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -Version 2.1 includes a global `output` option, to allow having more control over how commands output are printed to the console (see [documentation][output] for more info): - -```yaml -version: '2' - -output: prefixed - -tasks: - server: - cmds: - - go run main.go - prefix: server -``` - -From this version it's also possible to ignore errors of a command or task (check documentation [here][ignore_errors]): - -```yaml -version: '2' - -tasks: - example-1: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "This will be print" - - example-2: - cmds: - - exit 1 - - echo "This will be print" - ignore_error: true -``` - -## 版本 2.0 - -:::caution - -v2 schemas are [no longer supported by the latest version of Task][deprecate-version-2-schema]. - -::: - -到了 2.0 版本，我们引入了 `version:` 字段， 在不破坏已存在的 Taskfiles 的前提下，在 Task 中引入新功能。 新语法如下： - -```yaml -version: '2' - -tasks: - echo: - cmds: - - echo "Hello, World!" -``` - -如果您不想创建 `Taskvars.yml`，版本 2 允许您直接在 Taskfile 中写入全局变量： - -```yaml -version: '2' - -vars: - GREETING: Hello, World! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -变量的优先级调整为： - -1. Task 变量 -2. Call variables -3. Taskfile 定义变量 -4. Taskvars 文件定义变量 -5. Environment variables - -添加了一个新的全局配置项来配置变量扩展的数量（默认为 2）： - -```yaml -version: '2' - -expansions: 3 - -vars: - FOO: foo - BAR: bar - BAZ: baz - FOOBAR: '{{.FOO}}{{.BAR}}' - FOOBARBAZ: '{{.FOOBAR}}{{.BAZ}}' - -tasks: - default: - cmds: - - echo "{{.FOOBARBAZ}}" -``` - -## 版本 1 - -:::caution - -v1 schema support was removed in Task >= v3.0.0. - -::: - -最初的 `Taskfile` 并不支持 `version:` 关键字，因为 YAML 文档中的根属性都是 task。 就像这样： - -```yaml -echo: - cmds: - - echo "Hello, World!" -``` - -变量的优先级也不同： - -1. 调用变量 -2. 环境变量 -3. Task 变量 -4. `Taskvars.yml` 定义变量 - - - - -[deprecate-version-2-schema]: /deprecations/version-2-schema/ -[output]: /usage#output-syntax -[ignore_errors]: /usage#ignore-errors -[includes]: /usage#including-other-taskfiles diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/translate.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/translate.md deleted file mode 100644 index 56075229..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/translate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -slug: /translate/ -sidebar_position: 12 ---- - -# 翻译 - -想帮助我们翻译此文档吗？ 在本文档中，我们解释了如何解决这一问题。 - -不要直接在 GitHub 存储库上编辑翻译后的 markdown 文件！ 我们使用 [Crowdin][crowdin] 来允许贡献者进行翻译工作。 存储库会根据 Crowdin 的进展定期更新。 - -如果您想访问 Crowdin 项目以提供翻译建议，请在 [我们的 Discord 服务器上的 #translations 频道][discord] 上申请访问权限。 如果给定的语言尚未显示给 Crowdin，请询问，我们可以对其进行配置。 - - - - -[crowdin]: https://crowdin.com/project/taskfile -[discord]: https://discord.gg/6TY36E39UK diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage.md deleted file mode 100644 index 558c3250..00000000 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage.md +++ /dev/null @@ -1,1624 +0,0 @@ ---- -slug: /usage/ -sidebar_position: 3 ---- - -# 使用指南 - -## 快速入门 - -在项目的根目录中创建一个名为 `Taskfile.yml` 的文件。 `cmds` 属性应包含 task 的命令。 下面的示例允许编译 Go 应用程序并使用 [esbuild](https://esbuild.github.io/) 将多个 CSS 文件合并并缩小为一个文件。 - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -运行 task 就这样简单： - -```bash -task assets build -``` - -Task 使用 [mvdan.cc/sh](https://mvdan.cc/sh/)，一个原生的 Go sh 解释器。 因此，您可以编写 sh/bash 命令，它甚至可以在 Windows 上运行，而 `sh` 或 `bash` 通常不可用。 请记住，任何被调用的可执行文件都必须在操作系统或 PATH 中可用。 - -如果不传 task 的名字，默认会调用 "default"。 - -## 支持的文件名称 - -Task 会按以下顺序查找配置文件: - -- Taskfile.yml -- taskfile.yml -- Taskfile.yaml -- taskfile.yaml -- Taskfile.dist.yml -- taskfile.dist.yml -- Taskfile.dist.yaml -- taskfile.dist.yaml - -使用 `.dist` 变体的目的是允许项目有一个提交版本 (`.dist`)，同时仍然允许个人用户通过添加额外的 `Taskfile.yml`（将在 `.gitignore` 上）来覆盖 Taskfile。 - -### 从子目录运行 Taskfile - -如果在当前工作目录中找不到 Taskfile，它将沿着文件树向上查找，直到找到一个（类似于 `git` 的工作方式）。 当从这样的子目录运行 Task 时，它的行为就像从包含 Taskfile 的目录运行它一样。 - -您可以将此功能与特殊的 `{{.USER_WORKING_DIR}}` 变量一起使用来创建一些非常有用的可重用 task。 例如，如果你有一个包含每个微服务目录的 monorepo，你可以 `cd` 进入一个微服务目录并运行一个 task 命令来启动它，而不必创建多个 task 或具有相同内容的 Taskfile。 例如： - -```yaml -version: '3' - -tasks: - up: - dir: '{{.USER_WORKING_DIR}}' - preconditions: - - test -f docker-compose.yml - cmds: - - docker-compose up -d -``` - -在此示例中，我们可以运行 `cd ` 和 `task up`，只要 `` 目录包含 `docker-compose.yml`，就会启动 Docker Compose。 - -### 运行全局 Taskfile - -如果您使用 `--global`（别名 `-g`）标志调用 Task，它将查找您的 home 目录而不是您的工作目录。 简而言之，task 将寻找匹配 `$HOME/{T,t}askfile.{yml,yaml}` 的 配置文件。 - -这对于您可以在系统的任何地方运行的自动化很有用！ - -:::info - -当使用 `-g` 运行全局 Taskfile 时，task 将默认在 `$HOME` 上运行，而不是在您的工作目录上！ - -如前一节所述，`{{.USER_WORKING_DIR}}` 特殊变量在这里可以非常方便地在您从中调用 `task -g` 的目录中运行内容。 - -```yaml -version: '3' - -tasks: - from-home: - cmds: - - pwd - - from-working-directory: - dir: '{{.USER_WORKING_DIR}}' - cmds: - - pwd -``` - -::: - -## 环境变量 - -### Task - -你可以使用 `env` 给每个 task 设置自定义环境变量: - -```yaml -version: '3' - -tasks: - greet: - cmds: - - echo $GREETING - env: - GREETING: Hey, there! -``` - -此外，您可以设置可用于所有 task 的全局环境变量： - -```yaml -version: '3' - -env: - GREETING: Hey, there! - -tasks: - greet: - cmds: - - echo $GREETING -``` - -:::info - -`env` 支持扩展和检索 shell 命令的输出，就像变量一样，如您在 [变量](#变量) 部分中看到的那样。 - -::: - -### .env 文件 - -您还可以使用 `dotenv:` 设置要求 tasks 包含 `.env` 之类的文件 - -```bash title=".env" -KEYNAME=VALUE -``` - -```bash title="testing/.env" -ENDPOINT=testing.com -``` - -```yaml title="Taskfile.yml" -version: '3' - -env: - ENV: testing - -dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - -tasks: - greet: - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -也可以在 task 级别指定 .env 文件： - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -在 task 级别明确指定的环境变量将覆盖点文件中定义的变量： - -```yaml -version: '3' - -env: - ENV: testing - -tasks: - greet: - dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env'] - env: - KEYNAME: DIFFERENT_VALUE - cmds: - - echo "Using $KEYNAME and endpoint $ENDPOINT" -``` - -:::info - -请注意，您目前无法在包含的 Taskfile 中使用 `dotenv` 键。 - -::: - -## 包含其他 Taskfile - -如果要在不同项目（Taskfile）之间共享任务，可以使用导入机制使用 `includes` 关键字包含其他任务文件： - -```yaml -version: '3' - -includes: - docs: ./documentation # will look for ./documentation/Taskfile.yml - docker: ./DockerTasks.yml -``` - -给定的 Taskfile 中描述的任务将在指定的命名空间中提供。 因此，您可以调用 `task docs:serve` 从 `documentation/Taskfile.yml` 运行 `serve` task，或者调用 `task docker:build` 从 `DockerTasks.yml` 文件运行 `build` task。 - -相对路径是相对于包含包含 Taskfile 的目录解析的。 - -### 操作系统特定 Taskfile - -在 `version: '2'` 中，task 会自动尝试引入 `Taskfile_{{OS}}.yml` 文件 （例如`Taskfile_windows.yml`, `Taskfile_linux.yml` 或 `Taskfile_darwin.yml`）。 但是因为过于隐晦，在版本 3 中被移除了， 在版本 3 可以通过明确的引用来实现类似功能: - -```yaml -version: '3' - -includes: - build: ./Taskfile_{{OS}}.yml -``` - -### 包含 Taskfile 的目录 - -默认情况下，包含的 Taskfile 的 task 在当前目录中运行，即使 Taskfile 在另一个目录中，但您可以使用以下替代语法强制其 task 在另一个目录中运行： - -```yaml -version: '3' - -includes: - docs: - taskfile: ./docs/Taskfile.yml - dir: ./docs -``` - -:::info - -包含的 Taskfile 必须使用与主 Taskfile 使用的相同规则版本。 - -::: - -### 可选 includes - -如果包含文件丢失，标记为可选的包含将允许 task 继续正常执行。 - -```yaml -version: '3' - -includes: - tests: - taskfile: ./tests/Taskfile.yml - optional: true - -tasks: - greet: - cmds: - - echo "This command can still be successfully executed if - ./tests/Taskfile.yml does not exist" -``` - -### 内部 includes - -标记为 internal 的包含会将包含文件的所有 task 也设置为内部 task（请参阅下面的 [内部-tasks](#内部-tasks) 部分）。 这在包含不打算由用户直接使用的实用程序任务时很有用。 - -```yaml -version: '3' - -includes: - tests: - taskfile: ./taskfiles/Utils.yml - internal: true -``` - -### 包含 Taskfile 的变量 - -您还可以在包含 Taskfile 时指定变量。 这对于拥有可以调整甚至多次包含的可重用 Taskfile 可能很有用： - -```yaml -version: '3' - -includes: - backend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: backend_image - - frontend: - taskfile: ./taskfiles/Docker.yml - vars: - DOCKER_IMAGE: frontend_image -``` - -### 命名空间别名 - -包含 Taskfile 时，您可以为命名空间提供一个 `aliases` 列表。 这与 [task 别名](#task-别名) 的工作方式相同，可以一起使用来创建更短且更易于键入的命令。 - -```yaml -version: '3' - -includes: - generate: - taskfile: ./taskfiles/Generate.yml - aliases: [gen] -``` - -:::info - -在包含的 Taskfile 中声明的变量优先于包含 Taskfile 中的变量！ 如果您希望包含的 Taskfile 中的变量可被覆盖，请使用 [默认方法](https://go-task.github.io/slim-sprig/defaults.html)：`MY_VAR: '{{.MY_VAR | default "my-default-value"}}'`。 - -::: - -## 内部 tasks - -内部 task 是用户不能直接调用的 task。 运行 `task --list|--list-all` 时，它们不会出现在输出中。 其他 task 可以照常调用内部 task。 这对于创建在命令行上没有用处的可重用、类似函数的 task 很有用。 - -```yaml -version: '3' - -tasks: - build-image-1: - cmds: - - task: build-image - vars: - DOCKER_IMAGE: image-1 - - build-image: - internal: true - cmds: - - docker build -t {{.DOCKER_IMAGE}} . -``` - -## Task 目录 - -默认情况下，tasks 将在 Taskfile 所在的目录中执行。 但是您可以轻松地让 task 在另一个目录中运行，指定 `dir`： - -```yaml -version: '3' - -tasks: - serve: - dir: public/www - cmds: - # run http server - - caddy -``` - -如果该目录不存在，`task` 会创建它。 - -## Task 依赖 - -> 依赖项并行运行，因此一项 task 的依赖项不应相互依赖。 如果您想强制任务顺序运行，请查看下面的 [调用另一个 task](#调用另一个-task) 部分。 - -您可能有依赖于其它的 task。 将它们指向 `deps` 将使它们在运行父 task 之前自动运行： - -```yaml -version: '3' - -tasks: - build: - deps: [assets] - cmds: - - go build -v -i main.go - - assets: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -在上面的示例中，如果您运行 `task build`，`assets` 将始终在 `build` 之前运行。 - -一个 task 只能有依赖关系，没有命令来将 task 组合在一起： - -```yaml -version: '3' - -tasks: - assets: - deps: [js, css] - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -如果有多个依赖项，它们总是并行运行以获得更好的性能。 - -:::tip - -您还可以使用 `--parallel` 标志（别名 `-p`）使命令行给出的 task 并行运行。 例如: `task --parallel js css`。 - -::: - -如果你想将信息传递给依赖项，你可以像 [调用另一个 task](#调用另一个-task) 一样以相同的方式进行： - -```yaml -version: '3' - -tasks: - default: - deps: - - task: echo_sth - vars: { TEXT: 'before 1' } - - task: echo_sth - vars: { TEXT: 'before 2' } - silent: true - cmds: - - echo "after" - - echo_sth: - cmds: - - echo {{.TEXT}} -``` - -## 平台特定的 tasks 和 cmds - -如果您想将 task 的运行限制在明确的平台上，可以使用 `platforms:` 键来实现。 Task 可以限制在特定的操作系统、架构或两者的组合中。 如果不匹配，任务或命令将被跳过，并且不会抛出任何错误。 - -允许作为 OS 或 Arch 的值是有效的 `GOOS` 和 `GOARCH` 值，正如 [此处](https://github.com/golang/go/blob/master/src/go/build/syslist.go) 的 Go 语言所定义的那样。 - -下面的 `build-windows` task 将仅在 Windows 所有架构上运行： - -```yaml -version: '3' - -tasks: - build-windows: - platforms: [windows] - cmds: - - echo 'Running command on Windows' -``` - -这可以限制为特定的架构，如下所示： - -```yaml -version: '3' - -tasks: - build-windows-amd64: - platforms: [windows/amd64] - cmds: - - echo 'Running command on Windows (amd64)' -``` - -也可以将 task 限制在特定的架构中： - -```yaml -version: '3' - -tasks: - build-amd64: - platforms: [amd64] - cmds: - - echo 'Running command on amd64' -``` - -可以指定多个平台，如下所示： - -```yaml -version: '3' - -tasks: - build: - platforms: [windows/amd64, darwin] - cmds: - - echo 'Running command on Windows (amd64) and macOS' -``` - -个别命令也可以限制在特定平台上： - -```yaml -version: '3' - -tasks: - build: - cmds: - - cmd: echo 'Running command on Windows (amd64) and macOS' - platforms: [windows/amd64, darwin] - - cmd: echo 'Running on all platforms' -``` - -## 调用另一个 task - -当一个 task 有很多依赖时，它们是并发执行的。 这通常会导致更快的构建管道。 但是，在某些情况下，您可能需要串行调用其他 task。 在这种情况下，请使用以下语法： - -```yaml -version: '3' - -tasks: - main-task: - cmds: - - task: task-to-be-called - - task: another-task - - echo "Both done" - - task-to-be-called: - cmds: - - echo "Task to be called" - - another-task: - cmds: - - echo "Another task" -``` - -使用 `vars` 和 `silent` 属性，您可以选择在逐个调用的基础上传递变量和切换 [静默模式](#静默模式)： - -```yaml -version: '3' - -tasks: - greet: - vars: - RECIPIENT: '{{default "World" .RECIPIENT}}' - cmds: - - echo "Hello, {{.RECIPIENT}}!" - - greet-pessimistically: - cmds: - - task: greet - vars: { RECIPIENT: 'Cruel World' } - silent: true -``` - -`deps` 也支持上述语法。 - -:::tip - -注意：如果您想从 [包含的 Taskfile](#包含其他-taskfile) 中调用在根 Taskfile 中声明的 task，请像这样添加 `:` 前缀：`task: :task-name`。 - -::: - -## 减少不必要的工作 - -### 通过指纹识别本地生成的文件及其来源 - -如果一个 task 生成了一些东西，你可以通知 task 源和生成的文件，这样 task 就会在不需要的时候阻止运行它们。 - -```yaml -version: '3' - -tasks: - build: - deps: [js, css] - cmds: - - go build -v -i main.go - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - sources: - - src/js/**/*.js - generates: - - public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css - sources: - - src/css/**/*.css - generates: - - public/bundle.css -``` - -`sources` and `generates` can be files or glob patterns. 设置后， Task 会根据源文件的 checksum 来确定是否需要执行当前任务。 如果不需要执行， 则会输出像 `Task "js" is up to date` 这样的信息。 - -`exclude:` can also be used to exclude files from fingerprinting. Sources are evaluated in order, so `exclude:` must come after the positive glob it is negating. - -```yaml -version: '3' - -tasks: - css: - sources: - - mysources/**/*.css - - exclude: mysources/ignoreme.css - generates: - - public/bundle.css -``` - -If you prefer these check to be made by the modification timestamp of the files, instead of its checksum (content), just set the `method` property to `timestamp`. - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build . - sources: - - ./*.go - generates: - - app{{exeExt}} - method: timestamp -``` - -在需要更大灵活性的情况下，可以使用 `status` 关键字。 您甚至可以将两者结合起来。 有关示例，请参阅 [状态](#使用程序检查来表示任务是最新的) 文档。 - -:::info - -默认情况，task 在本地项目的 `.task` 目录保存 checksums 值。 一般都会在 `.gitignore`（或类似配置）中忽略掉这个目录，这样它就不会被提交。 (如果您有一个已提交的代码生成任务，那么提交该任务的校验和也是有意义的)。 - -如果你想要将这些文件存储在另一个目录中，你可以在你的机器中设置一个 `TASK_TEMP_DIR` 环境变量。 可以使用相对路径，比如 `tmp/task`，相对项目根目录，也可以用绝对路径、用户目录路径，比如 `/tmp/.task` 或 `~/.task`（每个项目单独创建子目录）。 - -```bash -export TASK_TEMP_DIR='~/.task' -``` - -::: - -:::info - -每个 task 只为其 `sources` 存储一个 checksum。 如果您想通过任何输入变量来区分 task，您可以将这些变量添加为 task 标签的一部分，它将被视为不同的 task。 - -如果您想为每个不同的输入集运行一次 task，直到 sources 实际发生变化，这将很有用。 例如，如果 sources 依赖于变量的值，或者您希望在某些参数发生变化时重新运行 task，即使 sources 没有发生变化也是如此。 - -::: - -:::tip - -将 method 设置为 `none` 会跳过任何验证并始终运行任务。 - -::: - -:::info - -要使 `checksum`（默认）或 `timestamp` 方法起作用，只需要通知 source 文件即可。 当使用 `timestamp` 方法时，最后一次运行 task 被认为是一次生成。 - -::: - -### 使用程序检查来表示任务是最新的 - -或者，您可以通知一系列测试作为 `status`。 如果没有错误返回（退出状态 0），task 被认为是最新的： - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - status: - - test -d directory - - test -f directory/file1.txt - - test -f directory/file2.txt -``` - -通常，您会将 `sources` 与 `generates` 结合使用 - 但对于生成远程工件（Docker 映像、部署、CD 版本）的 task，checksum source 和 timestamps 需要访问工件或 `.checksum` 指纹文件。 - -两个特殊变量 `{{.CHECKSUM}}` 和 `{{.TIMESTAMP}}` 可用于 `status` 命令中的插值，具体取决于分配给 sources 的指纹方法。 只有 `source` 块才能生成指纹。 - -请注意，`{{.TIMESTAMP}}` 变量是一个“实时”Go `time.Time` 结构，可以使用 `time.Time` 响应的任何方法进行格式化。 - -有关详细信息，请参阅 [Go Time 文档](https://golang.org/pkg/time/)。 - -如果你想强制任务运行，即使是最新的，你也可以使用 `--force` 或 `-f`。 - -此外，如果任何 task 不是最新的，`task --status [tasks]...` 将以非零退出代码退出。 - -如果 source/generated 的工件发生变化，或者程序检查失败，`status` 可以与 [指纹](#通过指纹识别本地生成的文件及其来源) 结合以运行任务： - -```yaml -version: '3' - -tasks: - build:prod: - desc: Build for production usage. - cmds: - - composer install - # Run this task if source files changes. - sources: - - composer.json - - composer.lock - generates: - - ./vendor/composer/installed.json - - ./vendor/autoload.php - # But also run the task if the last build was not a production build. - status: - - grep -q '"dev": false' ./vendor/composer/installed.json -``` - -### 使用程序检查取消任务及其依赖项的执行 - -除了 `status` 检查之外，`preconditions` 检查是 `status` 检查的逻辑逆过程。 也就是说，如果您需要一组特定的条件为 _true_，您可以使用 `preconditions`。 `preconditions` 类似于 `status` 行，除了它们支持 `sh` 扩展，并且它们应该全部返回 0。 - -```yaml -version: '3' - -tasks: - generate-files: - cmds: - - mkdir directory - - touch directory/file1.txt - - touch directory/file2.txt - # test existence of files - preconditions: - - test -f .env - - sh: '[ 1 = 0 ]' - msg: "One doesn't equal Zero, Halting" -``` - -先决条件可以设置特定的失败消息，这些消息可以使用 `msg` 字段告诉用户要采取什么步骤。 - -如果一个 task 依赖于一个具有前提条件的子 task，并且不满足该前提条件 - 调用 task 将失败。 请注意，除非给出 `--force` ，否则以失败的前提条件执行的 task 将不会运行。 - -与 `status` 判断 task 是最新状态时会跳过并继续执行不同， `precondition` 失败会导致 task 失败，以及所有依赖它的 task 都会失败。 - -```yaml -version: '3' - -tasks: - task-will-fail: - preconditions: - - sh: 'exit 1' - - task-will-also-fail: - deps: - - task-will-fail - - task-will-still-fail: - cmds: - - task: task-will-fail - - echo "I will not run" -``` - -### 在任务运行时限制 - -如果 task 由多个 `cmd` 或多个 `deps` 执行，您可以使用 `run` 控制何时执行。 `run` 也可以设置在 Taskfile 的根目录以更改所有任务的行为，除非被明确覆盖。 - -`run` 支持的值： - -- `always` （默认）总是尝试调用 task，无论先前执行的次数如何 -- `once` 只调用一次这个任务，不管引用的数量 -- `when_changed` 只为传递给 task 的每个唯一变量集调用一次 task - -```yaml -version: '3' - -tasks: - default: - cmds: - - task: generate-file - vars: { CONTENT: '1' } - - task: generate-file - vars: { CONTENT: '2' } - - task: generate-file - vars: { CONTENT: '2' } - - generate-file: - run: when_changed - deps: - - install-deps - cmds: - - echo {{.CONTENT}} - - install-deps: - run: once - cmds: - - sleep 5 # long operation like installing packages -``` - -### 确保设置所需变量 - -如果想要在运行任务之前检查是否设置了某些变量，那么 您可以使用 `requires`。 这可以显示一个明确的消息，帮助用户了解哪些变量是必需的。 比如，一些任务如果使用未设置的变量，可能会产生危险的副作用。 - -Using `requires` you specify an array of strings in the `vars` sub-section under `requires`, these strings are variable names which are checked prior to running the task. If any variables are un-set the the task will error and not run. - -Environmental variables are also checked. - -Syntax: - -```yaml -requires: - vars: [] # Array of strings -``` - -:::note - -Variables set to empty zero length strings, will pass the `requires` check. - -::: - -Example of using `requires`: - -```yaml -version: '3' - -tasks: - docker-build: - cmds: - - 'docker build . -t {{.IMAGE_NAME}}:{{.IMAGE_TAG}}' - - # Make sure these variables are set before running - requires: - vars: [IMAGE_NAME, IMAGE_TAG] -``` - -## 变量 - -在进行变量插值时，Task 将查找以下内容。 它们按权重顺序列在下面（即最重要的第一位）： - -- task 内部定义的变量 -- 被其它 task 调用时传入的变量(查看 [调用另一个 task](#调用另一个-task)) -- [包含其他 Taskfile](#包含其他-taskfile) 中的变量 (当包含其他 task 时) -- [包含 Taskfile](#包含-taskfile-的变量) 的变量（包含 task 时） -- 全局变量 (在 Taskfile 的 `vars:` 中声明) -- 环境变量 - -使用环境变量传输参数的示例： - -```bash -$ TASK_VARIABLE=a-value task do-something -``` - -:::tip - -包含任务名称的特殊变量 `.TASK` 始终可用。 - -::: - -由于某些 shell 不支持上述语法来设置环境变量 (Windows)，task 在不在命令开头时也接受类似的样式。 - -```bash -$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!" -``` - -本地声明的变量示例： - -```yaml -version: '3' - -tasks: - print-var: - cmds: - - echo "{{.VAR}}" - vars: - VAR: Hello! -``` - -`Taskfile.yml` 中的全局变量示例： - -```yaml -version: '3' - -vars: - GREETING: Hello from Taskfile! - -tasks: - greet: - cmds: - - echo "{{.GREETING}}" -``` - -### 动态变量 - -以下语法 (`sh:` prop in a variable) 被认为是动态变量。 该值将被视为命令并产生输出结果用于赋值。 如果有一个或多个尾随换行符，最后一个换行符将被修剪。 - -```yaml -version: '3' - -tasks: - build: - cmds: - - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go - vars: - GIT_COMMIT: - sh: git log -n 1 --format=%h -``` - -这适用于所有类型的变量。 - -## Looping over values - -As of v3.28.0, Task allows you to loop over certain values and execute a command for each. There are a number of ways to do this depending on the type of value you want to loop over. - -### Looping over a static list - -The simplest kind of loop is an explicit one. This is useful when you want to loop over a set of values that are known ahead of time. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: ['foo.txt', 'bar.txt'] - cmd: cat {{ .ITEM }} -``` - -### Looping over your task's sources - -You are also able to loop over the sources of your task: - -```yaml -version: '3' - -tasks: - default: - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{ .ITEM }} -``` - -This will also work if you use globbing syntax in your sources. For example, if you specify a source for `*.txt`, the loop will iterate over all files that match that glob. - -Source paths will always be returned as paths relative to the task directory. If you need to convert this to an absolute path, you can use the built-in `joinPath` function. There are some [special variables](/api/#special-variables) that you may find useful for this. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_DIR: /path/to/dir - dir: '{{.MY_DIR}}' - sources: - - foo.txt - - bar.txt - cmds: - - for: sources - cmd: cat {{joinPath .MY_DIR .ITEM}} -``` - -### Looping over variables - -To loop over the contents of a variable, you simply need to specify the variable you want to loop over. By default, variables will be split on any whitespace characters. - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -If you need to split on a different character, you can do this by specifying the `split` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt,bar.txt - cmds: - - for: { var: MY_VAR, split: ',' } - cmd: cat {{.ITEM}} -``` - -All of this also works with dynamic variables! - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: - sh: find -type f -name '*.txt' - cmds: - - for: { var: MY_VAR } - cmd: cat {{.ITEM}} -``` - -### Renaming variables - -If you want to rename the iterator variable to make it clearer what the value contains, you can do so by specifying the `as` property: - -```yaml -version: '3' - -tasks: - default: - vars: - MY_VAR: foo.txt bar.txt - cmds: - - for: { var: MY_VAR, as: FILE } - cmd: cat {{.FILE}} -``` - -### Looping over tasks - -Because the `for` property is defined at the `cmds` level, you can also use it alongside the `task` keyword to run tasks multiple times with different variables. - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: my-task - vars: - FILE: '{{.ITEM}}' - - my-task: - cmds: - - echo '{{.FILE}}' -``` - -Or if you want to run different tasks depending on the value of the loop: - -```yaml -version: '3' - -tasks: - default: - cmds: - - for: [foo, bar] - task: task-{{.ITEM}} - - task-foo: - cmds: - - echo 'foo' - - task-bar: - cmds: - - echo 'bar' -``` - -## 将 CLI 参数转发到 cmds - -如果 `--` 在 CLI 中给出，则所有以下参数都将添加到特殊的 `.CLI_ARGS` 变量中。 这对于将参数转发给另一个命令很有用。 - -下面的示例将运行 `yarn install`。 - -```bash -$ task yarn -- install -``` - -```yaml -version: '3' - -tasks: - yarn: - cmds: - - yarn {{.CLI_ARGS}} -``` - -## 使用 `defer` 做 task 清理 - -使用 `defer` 关键字，可以安排在 task 完成后运行清理。 与仅将其作为最后一个命令的不同之处在于，即使 task 失败，该命令也会运行。 - -在下面的示例中，即使第三个命令失败，`rm -rf tmpdir/` 也会运行： - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: rm -rf tmpdir/ - - echo 'Do work on tmpdir/' -``` - -使用其它 task 作为清理任务的命令时，可以这样： - -```yaml -version: '3' - -tasks: - default: - cmds: - - mkdir -p tmpdir/ - - defer: { task: cleanup } - - echo 'Do work on tmpdir/' - - cleanup: rm -rf tmpdir/ -``` - -:::info - -由于 [Go 自身的 `defer` 工作方式](https://go.dev/tour/flowcontrol/13) 的性质，如果您安排多个 defer命令，则 defer 命令将以相反的顺序执行。 - -::: - -## Go 的模板引擎 - -Task 在执行命令之前将命令解析为 [Go 的模板引擎][gotemplate]。 可以通过点语法 (`.VARNAME`) 访问变量。 - -Go 的 [slim-sprig 库](https://go-task.github.io/slim-sprig/) 的所有功能都可用。 以下示例按照给定格式获取当前日期： - -```yaml -version: '3' - -tasks: - print-date: - cmds: - - echo {{now | date "2006-01-02"}} -``` - -Task 还增加了以下功能： - -- `OS`：返回操作系统。 Possible values are `windows`, `linux`, `darwin` (macOS) and `freebsd`. -- `ARCH`: return the architecture Task was compiled to: `386`, `amd64`, `arm` or `s390x`. -- `splitLines`: Splits Unix (`\n`) and Windows (`\r\n`) styled newlines. -- `catLines`: Replaces Unix (`\n`) and Windows (`\r\n`) styled newlines with a space. -- `toSlash`：在 Unix 上不执行任何操作，但在 Windows 上将字符串从 `\` 路径格式转换为 `/`。 -- `fromSlash`：与 `toSlash` 相反。 在 Unix 上不执行任何操作，但在 Windows 上将字符串从 `/` 路径格式转换为 `\`。 -- `exeExt`：返回当前操作系统的正确可执行文件扩展名（Windows 为`“.exe”`，其他操作系统为`“”`）。 -- `shellQuote`：引用一个字符串以使其在 shell 脚本中安全使用。 Task 为此使用了 [这个 Go 函数](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)。 假定使用 Bash 语法。 -- `splitArgs`：将字符串作为命令的参数进行拆分。 Task 使用 [这个 Go 函数](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/shell#Fields) - -示例： - -```yaml -version: '3' - -tasks: - print-os: - cmds: - - echo '{{OS}} {{ARCH}}' - - echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}' - # This will be path/to/file on Unix but path\to\file on Windows - - echo '{{fromSlash "path/to/file"}}' - enumerated-file: - vars: - CONTENT: | - foo - bar - cmds: - - | - cat << EOF > output.txt - {{range $i, $line := .CONTENT | splitLines -}} - {{printf "%3d" $i}}: {{$line}} - {{end}}EOF -``` - -## 帮助 - -运行 `task --list`（或 `task -l`）列出所有带有描述的任务。 以下 Taskfile： - -```yaml -version: '3' - -tasks: - build: - desc: Build the go binary. - cmds: - - go build -v -i main.go - - test: - desc: Run all the go tests. - cmds: - - go test -race ./... - - js: - cmds: - - esbuild --bundle --minify js/index.js > public/bundle.js - - css: - cmds: - - esbuild --bundle --minify css/index.css > public/bundle.css -``` - -将打印以下输出： - -```bash -* build: Build the go binary. -* test: Run all the go tests. -``` - -如果您想查看所有任务，还有一个 `--list-all`（别名 `-a`）标志。 - -## 显示任务摘要 - -运行 `task --summary task-name` 将显示任务的摘要。 以下 Taskfile： - -```yaml -version: '3' - -tasks: - release: - deps: [build] - summary: | - Release your project to github - - It will build your project before starting the release. - Please make sure that you have set GITHUB_TOKEN before starting. - cmds: - - your-release-tool - - build: - cmds: - - your-build-tool -``` - -运行 `task --summary release` 将打印以下输出： - -``` -task: release - -Release your project to github - -It will build your project before starting the release. -Please make sure that you have set GITHUB_TOKEN before starting. - -dependencies: - - build - -commands: - - your-release-tool -``` - -如果缺少摘要，将打印描述。 如果任务没有摘要或描述，则会打印一条警告。 - -请注意：_显示摘要不会执行命令_。 - -## Task 别名 - -Aliases 是 task 的替代名称。 它们可以使运行具有长名称或难以键入名称的 task 变得更加容易和快速。 您可以在命令行上使用它们，在您的 Taskfile 中 [调用子任务](#调用另一个-task) 时以及在 [包含来自另一个 Taskfile](#包含其他-taskfile) 的别名 task 时。 它们也可以与 [命名空间别名](#命名空间别名) 一起使用。 - -```yaml -version: '3' - -tasks: - generate: - aliases: [gen] - cmds: - - task: gen-mocks - - generate-mocks: - aliases: [gen-mocks] - cmds: - - echo "generating..." -``` - -## 覆盖 Task 名称 - -有时你可能想覆盖打印在摘要上的 task 名称，最新消息到 STDOUT 等。 在这种情况下，你可以只设置 `label:`，也可以用变量进行插值： - -```yaml -version: '3' - -tasks: - default: - - task: print - vars: - MESSAGE: hello - - task: print - vars: - MESSAGE: world - - print: - label: 'print-{{.MESSAGE}}' - cmds: - - echo "{{.MESSAGE}}" -``` - -## 警告提示 - -Warning Prompts are used to prompt a user for confirmation before a task is executed. - -Below is an example using `prompt` with a dangerous command, that is called between two safe commands: - -```yaml -version: '3' - -tasks: - example: - cmds: - - task: not-dangerous - - task: dangerous - - task: another-not-dangerous - - not-dangerous: - cmds: - - echo 'not dangerous command' - - another-not-dangerous: - cmds: - - echo 'another not dangerous command' - - dangerous: - prompt: This is a dangerous command... Do you want to continue? - cmds: - - echo 'dangerous command' -``` - -```bash -❯ task dangerous -task: "This is a dangerous command... Do you want to continue?" [y/N] -``` - -Warning prompts are called before executing a task. If a prompt is denied Task will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue as normal. - -```bash -❯ task example -not dangerous command -task: "This is a dangerous command. Do you want to continue?" [y/N] -y -dangerous command -another not dangerous command -``` - -To skip warning prompts automatically, you can use the `--yes` (alias `-y`) option when calling the task. By including this option, all warnings, will be automatically confirmed, and no prompts will be shown. - -:::caution - -Tasks with prompts always fail by default on non-terminal environments, like a CI, where an `stdin` won't be available for the user to answer. In those cases, use `--yes` (`-y`) to force all tasks with a prompt to run. - -::: - -## 静默模式 - -静默模式在 Task 运行命令之前禁用命令回显。 对于以下 Taskfile： - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" -``` - -通常这将打印： - -```sh -echo "Print something" -Print something -``` - -开启静默模式后，将打印以下内容： - -```sh -Print something -``` - -开启静默模式有四种方式： - -- 在 cmds 级别： - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: echo "Print something" - silent: true -``` - -- 在 task 级别： - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "Print something" - silent: true -``` - -- 在 Taskfile 全局级别： - -```yaml -version: '3' - -silent: true - -tasks: - echo: - cmds: - - echo "Print something" -``` - -- 或者全局使用 `--silent` 或 `-s` 标志 - -如果您想改为禁止 STDOUT，只需将命令重定向到 `/dev/null`： - -```yaml -version: '3' - -tasks: - echo: - cmds: - - echo "This will print nothing" > /dev/null -``` - -## 试运行模式 - -试运行模式 (`--dry`) 编译并逐步完成每个 task，打印将运行但不执行它们的命令。 这对于调试您的 Taskfile 很有用。 - -## 忽略错误 - -您可以选择在命令执行期间忽略错误。 给定以下 Taskfile： - -```yaml -version: '3' - -tasks: - echo: - cmds: - - exit 1 - - echo "Hello World" -``` - -Task 将在运行 `exit 1` 后中止执行，因为状态代码 `1` 代表 `EXIT_FAILURE`。 但是，可以使用 `ignore_error` 继续执行： - -```yaml -version: '3' - -tasks: - echo: - cmds: - - cmd: exit 1 - ignore_error: true - - echo "Hello World" -``` - -也可以为 task 设置 `ignore_error`，这意味着所有命令的错误都将被忽略。 不过，请记住，此选项不会传播到由 deps 或 cmds 调用的其他 task！ - -## 输出语法 - -默认情况下，Task 只是将正在运行的命令的 STDOUT 和 STDERR 实时重定向到 shell。 这有利于通过命令打印日志记录的实时反馈，但如果同时运行多个命令并打印大量内容，输出可能会变得混乱。 - -为了使其更具可定制性，目前您可以选择三种不同的输出选项： - -- `interleaved` (默认) -- `group` -- `prefixed` - -要选择另一个，只需在 Taskfile 根目录中设置即可： - -```yaml -version: '3' - -output: 'group' - -tasks: - # ... -``` - -`group` 输出将在命令完成后打印一次命令的全部输出，因此您不会对需要很长时间运行的命令有实时反馈。 - -使用 `group` 输出时，您可以选择提供模板化消息以在组的开始和结束处打印。 这对于指示 CI 系统对给定任务的所有输出进行分组非常有用，例如使用 [GitHub Actions 的 `::group::` 命令](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) 或 [Azure Pipelines](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?expand=1&view=azure-devops&tabs=bash#formatting-commands)。 - -```yaml -version: '3' - -output: - group: - begin: '::group::{{.TASK}}' - end: '::endgroup::' - -tasks: - default: - cmds: - - echo 'Hello, World!' - silent: true -``` - -```bash -$ task default -::group::default -Hello, World! -::endgroup:: -``` - -使用 `group` 输出时，如果没有失败（零退出代码），您可以在标准输出和标准错误上执行命令的输出。 - -```yaml -version: '3' - -silent: true - -output: - group: - error_only: true - -tasks: - passes: echo 'output-of-passes' - errors: echo 'output-of-errors' && exit 1 -``` - -```bash -$ task passes -$ task errors -output-of-errors -task: Failed to run task "errors": exit status 1 -``` - -`prefix` 输出将为命令打印的每一行添加前缀 `[task-name]` 作为前缀，但您可以使用 `prefix:` 属性自定义命令的前缀： - -```yaml -version: '3' - -output: prefixed - -tasks: - default: - deps: - - task: print - vars: { TEXT: foo } - - task: print - vars: { TEXT: bar } - - task: print - vars: { TEXT: baz } - - print: - cmds: - - echo "{{.TEXT}}" - prefix: 'print-{{.TEXT}}' - silent: true -``` - -```bash -$ task default -[print-foo] foo -[print-bar] bar -[print-baz] baz -``` - -:::tip - -`output` 选项也可以由 `--output` 或 `-o` 标志指定。 - -::: - -## 交互式 CLI 应用 - -Task 执行包含交互式的命令时有时会出现奇怪的结果， 尤其当 [输出模式](#输出语法) 设置的不是 `interleaved` （默认）， 或者当交互式应用与其它 task 并发执行时。 - -`interactive: true` 告诉 Task 这是一个交互式应用程序，Task 将尝试针对它进行优化： - -```yaml -version: '3' - -tasks: - default: - cmds: - - vim my-file.txt - interactive: true -``` - -如果您在通过 Task 运行交互式应用程序时仍然遇到问题，请打开一个关于它的 Issue。 - -## 短 Task 语法 - -从 Task v3 开始，如果 task 具有默认设置（例如：没有自定义 `env:`、`vars:`、`desc:`、`silent:` 等），您现在可以使用更短的语法编写task： - -```yaml -version: '3' - -tasks: - build: go build -v -o ./app{{exeExt}} . - - run: - - task: build - - ./app{{exeExt}} -h localhost -p 8080 -``` - -## `set` 和 `shopt` - -可以为 [`set`](https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html) 和 [`shopt`](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html) 内置函数指定选项。 这可以在全局、task 或命令级别添加。 - -```yaml -version: '3' - -set: [pipefail] -shopt: [globstar] - -tasks: - # `globstar` required for double star globs to work - default: echo **/*.go -``` - -:::info - -请记住，并非所有选项在 Task 使用的 [shell 解释器库](https://github.com/mvdan/sh) 中都可用。 - -::: - -## 观察 task - -使用 `--watch` 或 `-w` 参数可以观察文件变化，然后重新执行 task。 这需要配置 `sources` 属性，task 才知道观察哪些文件。 - -默认监控的时间间隔是 5 秒，但可以通过 Taskfile 中根属性 `interval: '500ms'` 设置，也可以通过命令行 参数 `--interval=500ms` 设置。 - -Also, it's possible to set `watch: true` in a given task and it'll automatically run in watch mode: - -```yaml -version: '3' - -interval: 500ms - -tasks: - build: - desc: Builds the Go application - watch: true - sources: - - '**/*.go' - cmds: - - go build # ... -``` - -:::info - -Note that when setting `watch: true` to a task, it'll only run in watch mode when running from the CLI via `task my-watch-task`, but won't run in watch mode if called by another task, either directly or as a dependency. - -::: - - - - -[gotemplate]: https://golang.org/pkg/text/template/ diff --git a/docs/i18n/zh-Hans/docusaurus-theme-classic/footer.json b/docs/i18n/zh-Hans/docusaurus-theme-classic/footer.json deleted file mode 100644 index 8854fddd..00000000 --- a/docs/i18n/zh-Hans/docusaurus-theme-classic/footer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "link.title.Pages": { - "message": "页面", - "description": "The title of the footer links column with title=Pages in the footer" - }, - "link.title.Community": { - "message": "社区", - "description": "The title of the footer links column with title=Community in the footer" - }, - "link.title.Translations": { - "message": "翻译", - "description": "The title of the footer links column with title=Translations in the footer" - }, - "link.item.label.Installation": { - "message": "安装", - "description": "The label of footer link with label=Installation linking to /installation/" - }, - "link.item.label.Usage": { - "message": "使用指南", - "description": "The label of footer link with label=Usage linking to /usage/" - }, - "link.item.label.Donate": { - "message": "赞助", - "description": "The label of footer link with label=Donate linking to /donate/" - }, - "link.item.label.GitHub": { - "message": "GitHub", - "description": "The label of footer link with label=GitHub linking to https://github.com/go-task/task" - }, - "link.item.label.Twitter": { - "message": "Twitter", - "description": "The label of footer link with label=Twitter linking to https://twitter.com/taskfiledev" - }, - "link.item.label.Mastodon": { - "message": "Mastodon", - "description": "The label of footer link with label=Mastodon linking to https://fosstodon.org/@task" - }, - "link.item.label.Discord": { - "message": "Discord", - "description": "The label of footer link with label=Discord linking to https://discord.gg/6TY36E39UK" - }, - "link.item.label.OpenCollective": { - "message": "OpenCollective", - "description": "The label of footer link with label=OpenCollective linking to https://opencollective.com/task" - } -} diff --git a/docs/i18n/zh-Hans/docusaurus-theme-classic/navbar.json b/docs/i18n/zh-Hans/docusaurus-theme-classic/navbar.json deleted file mode 100644 index 6898733a..00000000 --- a/docs/i18n/zh-Hans/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "title": { - "message": "Task", - "description": "The title in the navbar" - }, - "item.label.Installation": { - "message": "安装", - "description": "Navbar item with label Installation" - }, - "item.label.Usage": { - "message": "使用指南", - "description": "Navbar item with label Usage" - }, - "item.label.API": { - "message": "接口", - "description": "Navbar item with label API" - }, - "item.label.Donate": { - "message": "赞助", - "description": "Navbar item with label Donate" - }, - "item.label.GitHub": { - "message": "GitHub", - "description": "Navbar item with label GitHub" - }, - "item.label.Twitter": { - "message": "Twitter", - "description": "Navbar item with label Twitter" - }, - "item.label.Mastodon": { - "message": "Mastodon", - "description": "Navbar item with label Mastodon" - }, - "item.label.Discord": { - "message": "Discord", - "description": "Navbar item with label Discord" - } -}